Retrieve Command Information (QCDRCMDI) API

The Retrieve Command Information (QCDRCMDI) API retrieves information from a command definition object and places it into a single variable in the calling program. The amount of information returned depends on the size of the variable. The information returned is the same information returned by the Display Command (DSPCMD) command.

You can use the QCDRCMDI API to retrieve any operable command. This includes both interactive (such as Display Program (DSPPGM) and Create Library (CRTLIB)) and non-interactive (such as DO, IF, and ELSE) commands. It does not include command definition statements that appear in command source, such as CMD, DEP, ELEM, PARM, PARMCTL, and QUAL.

Authorities and Locks

Command Definition Object Authority

*USE

Library Authority

*EXECUTE

Command Definition Object Lock

*SHRRD

Required Parameter Group

Receiver variable

OUTPUT; CHAR(*)

The variable that is to receive the information requested. The minimum size for this area is 8 bytes. You can specify the size of this area to be smaller than the format requested as long as you specify the length parameter correctly. As a result, the API returns only the data that the area can hold.

Length of receiver variable

INPUT; BINARY(4)

The length of the receiver variable. If this value is larger than the actual size of the receiver variable, the result may not be predictable. The minimum length is 8 bytes.

Format name

INPUT; CHAR(8)

The format of the command information to be returned. One of the following format names may be used:

CMDI0100 Format	Basic command information.
CMDI0200 Format	Complete command information.

Qualified command name

INPUT; CHAR(20)

The name of the command whose values are to be retrieved. The first 10 characters contain the name of the command. The second 10 characters contain the name of the library where the command is located.

You can use these special values for the library name:

*CURLIB	The job's current library
*LIBL	The library list

Error code

I/O; CHAR(*)

The structure in which to return error information. For the format of the structure, see Error Code Parameter.

CMDI0100 Format

The following table describes the information that is returned in the receiver variable for the CMDI0100 format. For detailed descriptions of the fields, see Field Descriptions.

Offset		Type	Field
Dec	Hex
0	0	BINARY(4)	Bytes returned
4	4	BINARY(4)	Bytes available
8	8	CHAR(10)	Command name
18	12	CHAR(10)	Command library name
28	1C	CHAR(10)	Command processing program or proxy target command name
38	26	CHAR(10)	Command processing program or proxy target command library name
48	30	CHAR(10)	Source file name
58	3A	CHAR(10)	Source file library name
68	44	CHAR(10)	Source file member name
78	4E	CHAR(10)	Validity check program name
88	58	CHAR(10)	Validity check program library name
98	62	CHAR(10)	Mode information
108	6C	CHAR(15)	Where allowed to run
123	7B	CHAR(1)	Allow limited user
124	7C	BINARY(4)	Maximum positional parameters
128	80	CHAR(10)	Prompt message file name
138	8A	CHAR(10)	Prompt message file library name
148	94	CHAR(10)	Message file name
158	9E	CHAR(10)	Message file library name
168	A8	CHAR(10)	Help panel group name
178	B2	CHAR(10)	Help panel group library name
188	BC	CHAR(10)	Help identifier
198	C6	CHAR(10)	Search index name
208	D0	CHAR(10)	Search index library name
218	DA	CHAR(10)	Current library
228	E4	CHAR(10)	Product library
238	EE	CHAR(10)	Prompt override program name
248	F8	CHAR(10)	Prompt override program library name
258	102	CHAR(6)	Restricted to target release
264	108	CHAR(50)	Text description
314	13A	CHAR(2)	Command processing program call state
316	13C	CHAR(2)	Validity check program call state
318	13E	CHAR(2)	Prompt override program call state
320	140	BINARY(4)	Offset to help bookshelf information
324	144	BINARY(4)	Length of help bookshelf information
328	148	BINARY(4)	Coded character set ID (CCSID)
332	14C	CHAR(1)	Enabled for GUI indicator
333	14D	CHAR(1)	Threadsafe indicator
334	14E	CHAR(1)	Multithreaded job action
335	14F	CHAR(1)	Proxy command indicator
336	150	CHAR(14)	Reserved
The offsets to these fields are specified in previous offset variables.		CHAR(*)	Help bookshelf information

CMDI0200 Format

The following table describes the information that is returned in the receiver variable for the CMDI0200 format. For detailed descriptions of the fields, see Field Descriptions.

Help Bookshelf Information

The following table describes the help bookshelf information that is returned for both the CMDI0100 and CMDI0200 formats.

Field Descriptions

For more information on the following fields, refer to the documentation for the Create Command (CRTCMD) command in the online help.

Allow limited user. Whether or not a user with limited authorities is allowed to run this command. The possible values are 0 (*NO) or 1 (*YES).

Bytes available. The length of all data available for the requested format. All available data is returned if enough space is provided.

Bytes returned. The length of all data actually returned. If the data is truncated because the receiver variable is not large enough to hold the data, this value is less than the bytes available.

Coded character set ID (CCSID). The value of the coded character set ID associated with this command. It is the value of the job coded character set ID when this command was created.

Command library name. The name of the library in which the command description resides.

Command name. The name of the command description about which information is being returned.

Command processing program call state. The state the command processing program is called from. The possible values are:

Command processing program or proxy target command library name. The name of the library in which the command processing program or proxy target command resides. This field is blank if the command processing program name contains the special value *REXX.

Command processing program nameor proxy target command name. The name of the program or target command that accepts parameters from the command and processes the command. Consult the proxy command indicator to determine if the value is a program or command name. The possible values are:

*REXX	The REXX fields returned in the CMDI0200 format contain valid information about the command.
CPP-program-name	The command processing program name.
Proxy target command name	The proxy target command name.

Current library. The name of the library used as the current library during the processing of this command. The possible values are:

Enabled for GUI indicator. Whether the command prompt panels are enabled for conversion to a graphical user interface. The possible values are:

Help bookshelf. The name of the help bookshelf for this command. The possible values are:

Help bookshelf information. Information describing the help bookshelf.

See Help Bookshelf Information for more details about help bookshelf information.

Help identifier. The name of the general help module for the names of the help identifiers for this command. The possible values are:

Help panel group library name. The name of the library in which the panel group resides.

Help panel group name. The name of the panel group in which the online help information exists for this command. If *NONE is returned, no help panel group is defined for this command.

Length of a REXX exit entry. The length of one REXX exit entry. This value is currently 24. There are 10 bytes for the REXX exit program name, 10 bytes for the REXX exit library name, and 4 bytes for the REXX exit code.

Length of help bookshelf information. The length of the help bookshelf.

Maximum positional parameters. The maximum number of parameters than can be coded in a positional manner for this command. The possible values are:

Message file library name. The name of the library in which the message file resides.

Message file name. The message file from which messages identified on the DEP statements used to define the command are retrieved.

Mode information. The mode of operating environment to which the command applies. The characters of this field are as follows, and they can have a value of 0 (does not apply) or 1 (does apply):

Multithreaded job action. The action to take when a command that is not threadsafe is called in a multithreaded job. The possible values are:

If the threadsafe indicator is either threadsafe or conditionally threadsafe, the multithreaded job action value will be returned as 1.

Number of REXX exit entries. The number of times the REXX exit entries are repeated. These fields are REXX exit program name, REXX exit program library name, and REXX exit code.

Offset to help bookshelf information. The offset to the help bookshelf information.

Product library. The name of the product library that is in effect during the processing of the command. The possible values are:

Prompt message file library name. The name of the library in which the prompt message file resides.

Prompt message file name. The name of the message file that contains the prompt text for this command. If *NONE is returned, no message file was specified for prompt text.

Prompt override program call state. The state the prompt override program is called from. The possible values are:

Prompt override program name. This is the name of the prompt override program that replaces default values (on the prompt display) with the current actual values for the parameter. If *NONE is returned, no prompt override program was specified for this command.

Proxy command indicator. Whether the command processing program name and command processing program library name fields contain program or command information. The possible values are:

Reserved. An ignored field.

Restricted to target release. The version, release, and modification level to which this command is restricted. If this field is blank, the command can be used in the current release. This applies only to a command used in a CL program. It must match the contents of the target release parameter on the Create CL Program (CRTCLPGM) command. See the CRTCLPGM command for more information. This field has the format VvRrMm, where:

REXX command environment library name. The name of the library in which the REXX command environment program resides.

REXX command environment name. The command environment program that is active when the REXX CPP starts to run. The REXX interpreter calls this program to process commands encountered in the REXX procedure. The possible values are:

REXX exit code. A value which controls the conditions in which the REXX exit program is called. The possible values are:

REXX exit program library name. The name of the library in which the REXX exit program resides.

REXX exit program name. The exit program used when the REXX interpreter is started under the conditions specified by the REXX exit code for this program.

REXX source file library name. The name of the library in which the REXX source file resides.

REXX source file member name. The name of the source file member that contains the REXX procedure that is the command processing program.

REXX source file name. The name of the source file that contains the REXX procedure that is the command processing program. The possible values are:

Search index library name. The name of the library in which the help search index resides.

Search index name. The name of the search index for this command. The possible values are:

Source file library name. The name of the library in which the source file resides.

Source file member name. The name of the source file member that contains the command definition statements used to create the command.

Source file name. The name of the source file that contains the source file member used to create the command.

Text description. The user text, if any, used to briefly describe the command and its function.

Threadsafe indicator. Whether the command can be used safely in

a multithreaded job.

The possible values are:

Validity check program call state. The state the validity check program is called from. The possible values are:

Validity check program library name. The name of the library in which the validity check program resides.

Validity check program name. The name of a program that performs additional user-defined validity checking on the parameters in the command. If *NONE is returned, no separate user-defined validity checking is done for this command. All validity checking is done by the command analyzer and the command processing program.

Where allowed to run. The environments in which this command is allowed to run. The characters of this field are as follows, and they can have a value of 0 (does not apply) or 1 (does apply):

Error Messages