xpfTrimString
| Code Block |
|---|
| titlelanguage | xpfTrimStringcpp |
|---|
| collapsetheme | trueConfluence |
|---|
|
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
|
This function will trim a string according to the given specification.The xpfTrimString() function has a variable number of arguments, i.e., it can be invoked with minimum 1 argument and maximum 4 arguments.
Arguments
...
| Type | Name | Comment |
STRING | actualString | The actual string to be trimmed |
STRING | prefixChars | Optional argument. Default 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 | suffixChars | Optional 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 | options | Optional argument. Default value is INDETERMINATE (?). Specifies the suffix of each substring. This suffix will be removed in the string splitting operation. |
Return Value
...
| Insert excerpt |
|---|
| US:_r_trimmedString |
|---|
| US:_r_trimmedString |
|---|
| nopanel | true |
|---|
|
Options
...
| Insert excerpt |
|---|
| US:_o_TRIM_STRING_PREFIX_ALL_NON_PRINTABLE_CHARS_XPX |
|---|
| US:_o_TRIM_STRING_PREFIX_ALL_NON_PRINTABLE_CHARS |
|---|
|
...
| Insert excerpt |
|---|
| US:_o_TRIM_STRING_SUFFIX_ALL_NON_PRINTABLE_CHARS_XPX |
|---|
| US:_o_TRIM_STRING_SUFFIX_ALL_NON_PRINTABLE_CHARS |
|---|
|
...
| Insert excerpt |
|---|
| US:_o_TRIM_STRING_SUFFIX_XPX |
|---|
| US:_o_TRIM_STRING_SUFFIX_XPX |
|---|
| nopanel | true |
|---|
|
| Insert excerpt |
|---|
| US:_o_TRIM_STRING_PREFIX_XPX |
|---|
| US:_o_TRIM_STRING_PREFIX_XPX |
|---|
| nopanel | true |
|---|
|
| Insert excerpt |
|---|
| US:_o_TRIM_STRING_PREFIX_WHITE_SPACE_XPX |
|---|
| US:_o_TRIM_STRING_PREFIX_WHITE_SPACE |
|---|
|
...
| Insert excerpt |
|---|
| US:_o_TRIM_STRING_SUFFIX_WHITE_SPACE |
|---|
|
...
| _XPX | | US:_o_TRIM_STRING_SUFFIX_WHITE_SPACE_XPX |
|---|
| nopanel | true |
|---|
|
Example
...
-- This removes all leading and trailing white spaces
trimmed_string := xpfTrimString(mystring,?,?,xpxTRIM_STRING_PREFIX_WHITE_SPACE ~| xpxTRIM_STRING_SUFFIX_WHITE_SPACE);
See also
| Filter by label (Content by label) |
|---|
| showLabels | false |
|---|
| showSpace | false |
|---|
| cql | label = "string" and parent = "5636522" |
|---|
|