Verbs and Built-in Functions › &SECCALL EXIT

&SECCALL EXIT

Provides a direct interaction between an NCL procedure and the installation's full security exit or partial security exit.

&SECCALL EXIT DATA=xxx ...  xxx | 
              VARS={ xxx | (xxx, ...,xxx) } |
              prefix* [ RANGE=(start,end) ] |
              ARGS [ RANGE=(start,end) ]

Operands:

DATA=xxx ... xxx

Any user variable that contains data to be passed to the security exit. Any number of variables is passed to the exit within the limitations of the maximum NCL statement length. The data passed to the exit is segmented into words on blanks.

VARS=

Specifies the names of the source variables to be passed to the security exit. Each variable will be passed as a separate word to the security exit. The formats of the operands that is coded with VARS= are:

VARS=xxx | ( xxx, ..., xxx )

The name of a variable, excluding the ampersand (&) prefix. A variable list is supplied by enclosing in brackets multiple names separated by commas.

VARS=prefix* [ RANGE=( start, end ) ]

Supplies the leading characters terminated by an asterisk that denote a numeric range of variables. If the RANGE= operand is specified or allowed to default, then an ascending numeric range is generated by concatenating the supplied prefix with a numeric suffix that is sequentially incremented within the supplied start and end values. The start and end values must be in the range 0 to 65535.

ARGS [ RANGE=( start, end ) ]

Supplies variables in the form &1 to &n. The RANGE= operand, as described previously, is coded to designate a start number and optionally an end number, which delimits the number of variables passed.

Return Codes:

On return from this function, &RETCODE is set to whatever return code was set (in Register 15) on return from the security exit. This must be in the range 0 to 99.

On return from the exit, returned data is constructed into variables &1, &2 ... &n, regardless of the names of the variables used to pass data to the exit. This function returns as many variables as there were operands passed.

Notes:

&SECCALL EXIT allows direct communication between EASINET NCL procedures and a security exit. This function allows a procedure to pass the contents of nominated variables to the security exit for processing and the security exit can return information exchanged between the procedure in defined variables. The content and processing of the information exchanged between the procedure and the exit is determined absolutely by the installation. Your product region has no knowledge of, or impact on, that information.

Using &SECCALL EXIT is valid only if a full or partial security exit is installed.

The NCL procedure must specify sufficient variables to hold all expected information from the security exit. Null variables are passed to the security exit when using &SECCALL EXIT DATA=. If the exit deletes all information from one of the variables, that variable is returned as a null variable. The procedure should be written to cater for this circumstance.