RCMD call

A Retrieve Command (RCMD) call enables an automated operator (AO) application program retrieve the second and subsequent command response segments after an ICMD call.

Format

Read syntax diagramSkip visual syntax diagramRCMDaibi/o area

Parameters

aib
Specifies the application interface block (AIB) used for this call. This parameter is an input and output parameter.
These fields must be initialized in the AIB:
AIBID
Eye catcher. This 8-byte field must contain DFSAIBbb.
AIBLEN
AIB lengths. This field must contain the actual length of the AIB that the application program obtained.
AIBOALEN
I/O area length. This field must contain the length of the I/O area specified in the call list. This field is not changed by IMS.
AIBOAUSE
Length of data returned in the I/O area. This parameter is an output parameter.

When partial data is returned because the I/O area is not large enough, AIBOAUSE contains the length required to receive all of the data, and AIBOALEN contains the actual length of the data.

i/o area
Specifies the I/O area to use for this call. This parameter is an output parameter. The I/O area should be large enough to hold the largest command response segment that is passed from IMS to the AO application program. If the I/O area is not large enough for all of the information, partial data is returned in the I/O area.

Usage

RCMD lets an AO application program retrieve the second and subsequent command response segments resulting from an ICMD call.

Related reading For more information on the AOI exits, see IMS Version 15.5 Exit Routines.

The following table shows, by IMS environment, the types of AO application programs that can issue RCMD. RCMD is also supported from a CPI-C driven program.

Table 1. RCMD support by application region type
  Application region type IMS environment
DBCTL DB/DC DCCTL
DRA thread Yes Yes N/A
BMP (nonmessage-driven) Yes Yes Yes
BMP (message-driven) N/A Yes Yes
MPP N/A Yes Yes
IFP N/A Yes Yes

RCMD retrieves only one response segment at a time. If you need additional response segments, you must issue RCMD one time for each response segment that is issued by IMS.

Restrictions

An ICMD call must be issued before an RCMD call.