inspect_user

Accepts a token for a user object and returns a list of the IDs contained in the user object.

Syntax, PL/M and C

CALL rq$inspect$user (user, IDs_ptr, except_ptr);

rq_inspect_user (user, IDs_ptr, except_ptr);

Parameters

userA token for the user object being inspected.

IDs_ptr
A pointer to this structure:

DECLARE IDs STRUCTURE(
lengthWORD_16,
countWORD_16,
IDs(*)WORD_16);

or

typedef struct {
UINT_16length;
UINT_16count;
UINT_16ids[2]; /* adjust to fit count */
} IDS_STRUCT;

Where:

lengthThe upper limit on the number of IDs to return. The calling task must supply this value; 0 values are not permitted.

countActual number of IDs that the BIOS returns.

IDsThe IDs the BIOS returns.

except_ptr
A pointer to a variable declared by the application where the call returns a condition code.

Additional Information

If the length value is smaller than the actual number of IDs in the user object, only the specified number of IDs returns.

Condition Codes