Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Code Block
languagecpp
themeConfluence
FUNCTION xpfTrimString (actualString  : STRING; -- actual string to be trimmed   
                        prefixChars   : STRING; -- optional; used in the TRIM_STRING_PREFIX option
                        suffixChars   : STRING; -- optional; used in the TRIM_STRING_SUFFIX option
                        options       : INTEGER)
                        trimmedString : STRING;   -- resulting trimmed string
                

Use this function to ....

Arguments

...

Insert excerpt
US:_a_actualString
US:_a_actualString
nopaneltrue
Insert excerpt
US:_a_prefixChars
US:_a_prefixChars
nopaneltrue
Insert excerpt
US:_a_suffixChars
US:_a_suffixChars
nopaneltrue
Insert excerpt
US:_a_options
US:_a_options
nopaneltrue

Return Value

...

 

Insert excerpt
US:_r_trimmedString
US:_r_trimmedString
nopaneltrue

Options

...

Insert excerpt
US:_o_XPX_TRIM_STRING_PREFIX_ALL_NON_PRINTABLE_CHARS
US:_o_XPX_TRIM_STRING_PREFIX_ALL_NON_PRINTABLE_CHARS
nopaneltrue
Insert excerpt
US:_o_XPX_TRIM_STRING_SUFFIX_ALL_NON_PRINTABLE_CHARS
US:_o_XPX_TRIM_STRING_SUFFIX_ALL_NON_PRINTABLE_CHARS
nopaneltrue
Insert excerpt
US:_o_XPX_TRIM_STRING_SUFFIX
US:_o_XPX_TRIM_STRING_SUFFIX
nopaneltrue
Insert excerpt
US:_o_XPX_TRIM_STRING_PREFIX
US:_o_XPX_TRIM_STRING_PREFIX
nopaneltrue
Insert excerpt
US:_o_XPX_TRIM_STRING_PREFIX_WHITE_SPACE
US:_o_XPX_TRIM_STRING_PREFIX_WHITE_SPACE
nopaneltrue
Insert excerpt
US:_o_XPX_TRIM_STRING_SUFFIX_WHITE_SPACE
US:_o_XPX_TRIM_STRING_SUFFIX_WHITE_SPACE
nopaneltrue

 

Example

...

<example missing>

 

See also

Filter by label (Content by label)
showLabelsfalse
showSpacefalse
cqllabel = "string" and parent = "5636522"

 

 xpfTrimString

Code Block
FUNCTION xpfTrimString (actualString  : STRING; -- actual string to be trimmed   
                        prefixChars   : STRING; -- optional; used in the TRIM_STRING_PREFIX option
                        suffixChars   : STRING; -- optional; used in the TRIM_STRING_SUFFIX option
                        options       : INTEGER)
                        trimmedString : STRING;   -- resulting trimmed string

Available options:

TRIM_STRING_PREFIX : remove the given prefixChars at the beginning of the string
TRIM_STRING_SUFFIX : remove the given suffixChars at the end of the string
TRIM_STRING_PREFIX_ALL_NON_PRINTABLE_CHARS  : Remove all non printable characters at the beginning of the string
                                                                                       Non printable characters are the character with the following ASCII values:
                                                                                      ( 0 < char <= 31) and (127 < char <= 160) 
TRIM_STRING_SUFFIX_ALL_NON_PRINTABLE_CHARS  : Remove all non printable characters at end of the string
TRIM_STRING_PREFIX_WHITE_SPACE    : Remove all spaces at the beginning of the string
TRIM_STRING_SUFFIX_WHITE_SPACE    : Remove all spaces at the end of the string

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

has the same functionality, same arguments and options, as the xpfTrimString function, except the "actualString" will be trimmed, i.e., this function will not return the trimmed string, but change the "actualString".

Hans Karsten