CAS Programming Interface ($CACALL) › $CACALL API

$CACALL API

The syntax for invoking $CACALL is as follows:

-EXEC $CACALL   OPT=ACTION
                ACTION={BUILD | DISPLAY | EDIT | EXECUTE | GET |
                           LOAD | NAVIGATE | VALIDATE}
                CLASS={COMMAND | CRITERIA | DATA | FKA |
                HELP | IDTEXT | LIST | MENU | MESSAGE |
                PDOMAIN | TABLE | TENTRY}
               [NAME='attribute1=value1 attribute 2=value2 ... 
                      attributen=valuen']
               [PARMS='parm1=value1 parm2=value2 ... parmn=valuen']

• OPT=ACTION

  Specifies an optional parameter indicating the option required.

• ACTION={BUILD | DISPLAY | EDIT | EXECUTE | GET | LOAD |
                    NAVIGATE | VALIDATE}

  Specifies a required parameter indicating the action to perform.

• CLASS={COMMAND | CRITERIA | DATA | FKA | HELP | IDTEXT | LIST |
                 MENU | MESSAGE | PDOMAIN | TABLE | TENTRY}

  Specifies a required parameter that identifies the class on which the action is to be performed.

• NAME='attribute1=value1 attribute2=value2 ... attributen=valuen'

  Specifies an optional parameter that provides the attribute IDs and values that identify the object to process.

• PARMS='parm1=value1 parm2=value2 ... parmn=valuen'

  Specifies optional keyword parameters. These parameters are documented with the individual calls.

Note: If any value (that is, value1..n) specified in the NAME or PARMS operand contains embedded blanks, quotes, or double quotes, then the value and the entire operand must be quoted as described in the &ZQUOTE verb description in the Network Control Language Reference Guide.

Input Variables

Any required input variables are described for the individual calls.

Return Variables

Any variables set by $CACALL are described for the individual calls.

Return Codes

$CACALL sets one of the following return codes:

• 0

  OK

• 8

  Error

Feedback Codes

If a return code of 8 is set, then additional information is available as one of the following feedback codes, set in &$CAFDBK:

• 0

  No feedback code set

• 1

  Definition not found

• 2

  No data found

• 3

  Canceled by exit

• 4

  Canceled by user

• 5

  End of sequence

• 6

  Unable to obtain lock

• 7

  User not authorized

• 8

  Processing error

• 9

  Return requested

• 10

  Nesting level exceeded

• 11

  Definition not eligible for processing