xpfStringToLowercaseEx

FUNCTION xpfStringToLowercaseEx(sourceString                : STRING;
                                 options                     : INTEGER;
                                 extendedLowercaseCharacters : STRING)
                                 lowercaseString: STRING;
                

This function will return an lower case string from a possible "mixed lower case/upper case" string. The xpfStringToLowercaseEx() function is an extended version of the xpfStringToLowerCase() and xpxStringToLowerCase() functions The extension is that a defined set of lower case characters will be defined for this operation. It is assumed that the actual upper case value of the extended lower case characters, have the ASCII value (lowerCaseValue - 31). This function has variable number of arguments, i.e., it can be invoked with minimum 1 argument and maximum 3 arguments.

 

Arguments


1TypeNameComment
2
STRING
sourceString
The actual string in possibly "mixed lower / upper case" format that will be returned in upper case format
3
INTEGER
optionsOptional argument. Default value is INDETERMINATE (?)
4
STRING
extendedLowercaseCharactersOptional argument. Default value is INDETERMINATE (?). Specifies a set of lower case characters for this operation

Return Value


 

TypeNameComment
STRINGlowercaseStringThe resulting lower case string will be returned when the function is successfully performed. The value INDETERMINATE (?) will be returned when the function fails. Exception handling should be used to handle error conditions in the actual xpfStringToLowercaseEx() operation.

Options


 OptionComment
1xpxSYSTEM_DEFINED_EXTENSIONUse the system defined extra lower case characters in the operation. The system defined extra lower case characters is set by the EDM_EXTENDED_LOWERCASE_CHARACTERS configuration variable.

 

Example


<Missing Example>

 

See also

Filter by label

There are no items with the selected labels at this time.

Â