CAS Programming Interface ($CACALL) › Action=BUILD Class=IDTEXT

Action=BUILD Class=IDTEXT

This statement builds the ID text that contains information about a user.

This statement has the following format:

&CONTROL SHRVARS=($CAID)
-EXEC $CACALL      OPT=ACTION
                   ACTION=BUILD
                   CLASS=IDTEXT
                   [NAME=‘USER=userid’]
                   [PARMS=‘[BORDER={YES | NO}]
                           [LENGTH={80 | length}]
                           [DATE=date]
                           [TIME=time]’]

USER=userid

An optional parameter giving the ID of the user whose ID text is to be built. The default is the current user ID.

BORDER={YES | NO}

An optional parameter specifying whether there are borders at the top and bottom of the built ID text. The default is YES.

LENGTH={80 | length}

An optional parameter specifying the length of the horizontal border lines if BORDER=YES. The default is 80, and the range is 1 through 255.

DATE=date

An optional parameter specifying the date (in DATE3 format) to be included in the built ID text. The default is the current date.

TIME=time

An optional parameter specifying the time (in hh.mm.ss format) to be included in the built ID text. The default is the current time.

Input Variables

This statement has no input variables.

Return Variables

This statement contains the following return variables:

&$CAIDTXn

Contains the built ID text strings.

&$CAIDTXTOT

Contains the number of ID text strings built. The value gives the number of &$CAIDTXn variables.

&SYSMSG

System message. Contains the error message (for return code 8).

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:

8

Processing error

10

Nesting level exceeded

Example

The following statements build the ID text for the current user. The text contains the current date and time, and has 80-character borders at the top and bottom.

&CONTROL SHRVARS=($CAID)
-EXEC $CACALL   OPT=ACTION +
                ACTION=BUILD +
                CLASS=IDTEXT +
                NAME=‘USER=&USERID’ +
                PARMS=‘BORDER=YES +
                       LENGTH=80’