Previous Topic: &SECCALL EXIT

Next Topic: &SECCALL QUERY

Verbs and Built-in Functions › &SECCALL GET

&SECCALL GET

Provides the ability to retrieve the nominated user's security attributes and privileges.

&SECCALL GET USERID=userid
             FIELDS={ (nnnn,...,nnnn) | * }
           [ OPT={ KEQ | KGT | KLT } ]
           [ PREFIX=prefix ]

Operands:

USERID=userid

The user ID of the target user which is to be retrieved. The user ID must be 1 to 8 characters long and defined to the security subsystem.

FIELDS={ (nnnn,...,nnnn) | * }

Provides a list of nominated structured field values for which the security attributes for the user ID are to be retrieved.

Note: For more information about structured fields, see the Security Guide.

A list of structured field values is supplied or an asterisk (*) is used to specify that all security attributes are to be returned. The variables are set as indicated by the required structured fields and are returned to the NCL procedure in the form &prefixnnnn, where prefix is defined by the PREFIX operand and nnnn is a defined structured field for this system.

OPT={ KEQ | KGT | KLT }

Indicates which record, in relation to the user ID specified in the USERID operand, is to be retrieved.

OPT=KEQ indicates that you wish to retrieve the user definition with an exact match on the specified user ID.

OPT=KGT indicates that you wish to retrieve the user definition with the lowest key value greater than the specified user ID. A key of blanks retrieves the first user ID record on UAMS.

OPT=KLT indicates that you wish to retrieve the user definition with the highest key value less than the specified user ID.

If a full security is installed, then the options KGT and KLT are presented to the security exit. It is up to the security exit to decide whether to support the call and to return the correct user ID information.

PREFIX=prefix

Defines a 1- to 7-character prefix of the variables referred to by the FIELDS operand. The default is SEC.

Return Codes:

The result of the GET function is indicated by the setting of &RETCODE as follows:

0

Request successful. The user ID attributes are available in the user variables generically named &SECnnnn.

4

Request unsuccessful. The user ID information was not available. &SYSMSG is set to contain an error message indicating cause of failure.

More information:

&SECCALL