Parameters for the COMMAND request
You can use this information to understand the parameters for the DBRC COMMAND request. Each parameter is explained as it relates to the COMMAND request syntax diagram.
- name
- Specifies the name parameter. If used, begins in column 1.
- COMMAND=symbol | (2 - 12)
- Specifies the address of a DBRC utility command to execute. The command consists of a header followed by a DBRC command. The header is a full word that contains the length (in bytes) of the following command. The DBRC command must conform to DBRC command syntax, except that the command cannot be continued. Separators, which are blanks, a comma or a comment, are allowed anywhere in the command where a separator is needed and may validly appear at the beginning of the command.
- TOKEN=symbol | (2 - 12)
- Specifies the address of a 4-byte field to receive the API token. This token must be included in all subsequent requests that are associated with this DSPAPI request.
- OUTPUT=output | (2 - 12)
- Specifies a field to receive a pointer to the block that contains the information for the command.
- SUPPRESS= | NO | YES
- Specifies whether or not the command output is to be returned. SUPPRESS=YES indicates that command output is to be returned only if the command does not complete successfully (return code is not zero). SUPPRESS=NO indicates that command output is always returned. SUPPRESS=NO is the default.
- BUFFERLENGTH=4096 | number | (2 - 12)
- Specifies the length of a buffer to receive the output that is generated by executing the command. If a register is specified, the register must contain the desired length. The maximum length allowed is 32 760. If necessary, the length is rounded up to a double-word boundary. The default and minimum value is 4096.
- SUBPOOL=0 | number
- Specifies the subpool number for the storage being obtained. If not specified, the default is the subpool specified by the FUNC=STARTDBRC request. Otherwise, subpool 0 is the default.
- RETCODE=return code | (2-12)
- If specified as a symbol, specifies the label of a word of storage to receive the return code. If specified as a register, the register must contain the address of a word of storage to receive the return code. Regardless of whether RETCODE is specified, register 15 contains the return code.
- RSNCODE=reason code | (2-12)
- If specified as a symbol, the symbol must be the label of a word of storage to receive the reason code. If specified as a register, the register must contain the address of a word of storage to receive the reason code. Regardless of whether RSNCODE is specified, register 0 contains the reason code.
- MF=S | L | M | E
- Specifies the macro form of the request.
- VERSION=2.0 | number
- Specifies the version number of the parameter list to be generated
by this request.
To use the parameters associated with a version, you must specify the number of that version or a later version. If you specify an earlier version level, the parameter is not accepted for processing and an error message is issued at assembly time. If parameters have a version dependency, the parameter descriptions with each request type identify the version number required.
The default version is 2.0.