Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

Arguments

...

Insert excerptUS:_a_actualStringUS:_a_actualStringnopaneltrue Insert excerptUS:_a_prefixCharsUS:_a_prefixCharsnopaneltrue Insert excerptUS:_a_suffixCharsUS:_a_suffixCharsnopaneltrue Insert excerptUS:_a_options_XPXUS:_a_options_XPXnopaneltrue 

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

...

 

Insert excerpt
US:_r_XPX_Return_Value
US:_r_XPX_Return_Value
nopaneltrue

...