LOTUSSCRIPT LANGUAGE


LenBP function
Returns the length of a string in bytes, or the number of bytes used to hold a variable, in the platform-native character set.

Syntax

LenBP ( { stringExpr | variantExpr | numericExpr | typeName } )

Elements

stringExpr


variantExpr
numericExpr
typeName
Return value

For stringExpr, LenBP returns the number of bytes in the string expression.

For variantExpr, LenBP returns the number of bytes required to hold the value of variantExpr converted to a String.

For numericExpr, LenBP returns the number of bytes required to hold the contents of numericExpr.

For typeName, LenBP returns the number of bytes required to hold the contents of all the member variables, unless the user-defined data type includes Variant or variable-length String members. In that case, the length of the variable of the user-defined data type may not be the same as the sum of the lengths of its member variables.

Usage

LenBP(NULL) generates an error.

LenBP(v), where v is EMPTY, returns 0.

To determine the length of a string in characters, use the Len function. To determine the length of a string in bytes in the LotusScript internal character set, use the LenB function. To determine the length of a string in columns (for column-based languages) use the LenC function.

See Also