LeftBP function (LotusScript® Language)

Extracts a specified number of the leftmost bytes in a string using the platform-specified character set.


LeftBP[$] ( expr , n )



Any numeric or String expression for LeftBP; and any Variant or String expression for LeftBP$. If expr is numeric, LotusScript® converts it to a string before performing the extraction.


The number of bytes to be returned using the platform-specified character set.

Return value

LeftBP returns a Variant of DataType 8 (a String), and LeftBP$ returns a String.

If n is 0, the function returns the empty string (""). If n is greater than the length (in bytes) of expr, the function returns the entire string.

LeftBP(NULL) returns NULL. LeftBP$(NULL) is an error.

If a double-byte character is divided, the character is not included.