Difference between revisions of "Programmer Guide/Command Reference/TRIM"

From STX Wiki
Jump to navigation Jump to search
Line 2: Line 2:
 
  TRIM [ /Blanks ] [ /Characters=<var>abcde</var> ] [ /Leading ] [ /Trailing ] [ /Variables ] /- <var>string(s)</var>
 
  TRIM [ /Blanks ] [ /Characters=<var>abcde</var> ] [ /Leading ] [ /Trailing ] [ /Variables ] /- <var>string(s)</var>
  
The <code>TRIM</code> command removes characters from the beginning and/or from the end of one or more strings.
+
The {{Stx}} <code>TRIM</code> command removes characters from the beginning and/or from the end of one or more strings.
  
For each supplied string, the <code>TRIM</code> command will remove all leading (option "<code>/Leading</code>") and/or trailing ("<code>/Trailing</code>") occurrences of any white space character (option "<code>/Blanks</code>") and/or of any character supplied as an argument to the "<code>/Characters</code>" option.
+
For each supplied string, the {{STx}} <code>TRIM</code> command will remove all leading (option "<code>/Leading</code>") and/or trailing ("<code>/Trailing</code>") occurrences of any white space character (option "<code>/Blanks</code>") and/or of any character supplied as an argument to the "<code>/Characters</code>" option.
  
 
The command returns the trimmed strings or, if more than one string is supplied, a blank-separated list of trimmed strings.
 
The command returns the trimmed strings or, if more than one string is supplied, a blank-separated list of trimmed strings.
  
If option "<code>/Variables</code>" is supplied, the arguments are considered to be the names of variables. In this case, the contents of the variables are trimmed.
+
If option "<code>/Variables</code>" is supplied, the arguments are considered to be the names of {{STX}} variables. In this case, the contents of the variables are trimmed.
  
 
== Examples ==
 
== Examples ==

Revision as of 15:22, 7 May 2014

TRIM [ /Blanks ] [ /Characters=abcde ] [ /Leading ] [ /Trailing ] [ /Variables ] /- string(s)

The STx TRIM command removes characters from the beginning and/or from the end of one or more strings.

For each supplied string, the STx TRIM command will remove all leading (option "/Leading") and/or trailing ("/Trailing") occurrences of any white space character (option "/Blanks") and/or of any character supplied as an argument to the "/Characters" option.

The command returns the trimmed strings or, if more than one string is supplied, a blank-separated list of trimmed strings.

If option "/Variables" is supplied, the arguments are considered to be the names of STx variables. In this case, the contents of the variables are trimmed.

Examples

#a := trim /l /b /- '   string   '

will remove all leading white space characters

#a := trim /b /l /c=abc 'aaastringccc'

will remove all leading and trailing occurrences of the characters "a", "b", and "c".