xpxTrimString

FUNCTION xpxTrimString (VAR actualString : STRING;
                        prefixChars      : STRING;
                        suffixChars      : STRING;
                        options          : INTEGER)
                        status           : INTEGER;
                

This function will trim a string according to the given specification. The actualString will be overwritten by the resulting string.

Arguments


 

TypeNameComment
STRING
actualString 
On input:   the untrimmed string. On output: the trimmed string.
STRING
prefixCharsDefault is INDETERMINATE (?). This argument specifies a set of characters that will be used in trimming the start (prefix) of the actualString . This argument is only effective when the option xpxTRIM_STRING_PREFIX is specified.
STRING
suffixCharsOptional argument. Default is INDETERMINATE (?). This argument specifies a set of characters that will be used in trimming the end (suffix) of the actualString . This argument is only effective when the option xpxTRIM_STRING_SUFFIX is specified.
INTEGER
optionsOptional argument. The default value is "xpxTRIM_STRING_PREFIX_ALL_NON_PRINTABLE_CHARS ~| xpxTRIM_STRING_SUFFIX_ALL_NON_PRINTABLE_CHARS ~| xpxTRIM_STRING_PREFIX_WHITE_SPACE ~| xpxTRIM_STRING_SUFFIX_WHITE_SPACE"

Return Value


 

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'US:_r_XPX_Return_Value'.

Options


1OptionComment
2
xpxTRIM_STRING_PREFIX_ALL_NON_PRINTABLE_CHARS


All non printable characters in the beginning of the given string will be removed. Non printable characters are defined to be the characters with the following ASCII value intervals: 1 - 31, 127 - 160

3xpxTRIM_STRING_SUFFIX_ALL_NON_PRINTABLE_CHARSAll non printable characters in the end of the given string will be removed
4xpxTRIM_STRING_SUFFIXThe set of characters specified in the "suffixChars" argument will be removed from the end of the given string
5xpxTRIM_STRING_PREFIXThe set of characters specified in the "prefixChars" argument will be removed from the start of the given string
6xpxTRIM_STRING_PREFIX_WHITE_SPACERemove all spaces at the beginning of the string
7xpxTRIM_STRING_SUFFIX_WHITE_SPACERemove all spaces at the end of the string

Example


<Missing Example>

 

See also

Filter by label

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