FUNCTIONS

Generated from C.60.01 /SYS/PUB/CICAT last modified on Thu Jan 11 09:18:52 2001

Back to Main Index

A Command Interpreter (CI) function works similarly to functions in
other programming languages.  It is invoked by name and returns a
result via its name.  In evaluating an expression, the CI invokes
all functions, replacing their name and arguments with the result of
the function.

There are many CI functions which can be categorized as follows:
I.    Filename functions:
      BASENAME, DIRNAME, FINFO, FSYNTAX, FQUALIFY

II.   Parsing functions:
      ALPHA, ALPHANUM, DELIMPOS, DWNS, EDIT, LEN, LFT, LTRIM, NUMERIC,
      PMATCH, POS, REPL, RHT, RPT, RTRIM, STR, UPS, WORD, WORDCNT,
      XWORD

III.  Conversion functions:
      CHR, DECIMAL, HEX, OCTAL, ORD

IV.   Bit functions:
      BAND, BNOT, BOR, BXOR, CSL, CSR, LSL, LSR, ODD

V.    Arithmetic functions:
      ABS, MAX, MIN, MOD

VI.   Logical functions:
      AND, OR, NOT, XOR

VII.  Job functions:
      JINFO, JOBCNT

VIII. Misc. functions:
      ANYPARM, BOUND, INPUT, SETVAR, TYPEOF


The table below lists and briefly describes all CI functions.  For
more detailed information about a particular function, enter HELP
, for example: HELP WORD or HELP FQUALIFY.

For additional information, enter "VARIABLES", "EXPRESSIONS", and
"OPERATORS" at the HELP prompt.

---------- Expression Evaluator Functions ---------------------------

Function           Description

ABS                Returns the absolute value of an integer
ALPHA              Determines if a string is alphabetic
ALPHANUM           Determines if a string is alphabetic and digits
AND                Performs logical and
ANYPARM            Treat all characters in its argument as a single
                   string
BAND               Performs bitwise and
BASENAME           Extracts the filename portion of an MPE or POSIX name
BNOT               Performs bitwise not
BOR                Performs bitwise or
BOUND              Tests for the existence of a variable
BXOR               Performs bitwise exclusive or
CHR                Interprets an ASCII number as a character
CSL                Performs circular shift left
CSR                Performs circular shift right
DECIMAL            Converts an integer number to a string
DELIMPOS           Returns the position of the nth delimeter in a string
DIRNAME            Extracts the directory components of a filename
DWNS               Shifts string to lowercase
EDIT               Performs full REDO-like editing of a string
FINFO              Returns information about a file
FQUALIFY           Qualifies a filename
FSYNTAX            Returns the syntax of a filename
HEX                Converts integer to hexadecimal string
INPUT*             Accepts user input from $STDIN or the console
JINFO              Returns information about a job/session
JOBCNT             Returns number of jobs matching jobID string
LEN                Return length of string
LFT                Performs left string extraction
LSL                Logical shift left
LSR                Logical shift right
LTRIM              Trims left end of string
MAX                Finds the largest of several integers
MIN                Finds the smallest of several integers
MOD                Calculates the modulo of two numbers
NOT                Performs logical not
NUMERIC            Determines if a string is all digits
OCTAL              Converts integer to octal string
ODD                Determines if an integer is odd
OR                 Performs logical or
ORD                Interprets a character as an ASCII number
PMATCH             Searches for a pattern in a string
POS                Finds the index of one string in another
REPL               Replaces specified number of occurrences of an old
                   string with a new one
RHT                Performs right string extraction
RPT                Repeats/reverses string a specified number of times
RTRIM              Trims right end of string
SETVAR*            Returns the result of an expression and sets varname
                   to that result.
STR                Performs general string extraction
TYPEOF             Returns type of variable or expression
UPS                Shifts string to uppercase
WORD               Performs general word extraction
WORDCNT            Returns the number of words(tokens)
XOR                Performs logical exclusive or
XWORD              Extracts all but the selected word.


For an expanded definition, the syntax, and one or more examples of
any of these functions, enter the function name at the HELP prompt.

* NOTE:  To see more information about the INPUT or SETVAR functions,
         enter the function name followed by "FN", e.g. INPUTFN.
         If you enter the name without the "FN" suffix, (e.g. INPUT),
         you will see a description of the CI command of the same
         name.

Back to Main Index