|
|
|
Returns information on a specified pending reply request.
Syntax
REC I32A @64A
AIFREPLYGET ( overall_status, itemnum_array, item_array,
RECA I32 I32
itemstatus_array, reply_request_id, user_id );
Parameters
- overall_status
- record by reference (required)
Returns the overall status of the call. A zero indicates a successful
call. A negative value indicates an error in the overall call, not
specific to any particular item. A positive value indicates the last
element in itemstatus_array, signaling an error condition. Refer to
appendix A for meanings of status values.
Record type: status_type (Refer to appendix B.)
- itemnum_array
- 32-bit signed integer array by reference (required)
An array of integers where each element is an item number indicating the
information to be returned to a data structure pointed to in the
corresponding element in item_array. If n item numbers
are being requested, element n+1 must be a zero to
indicate the end of the element list.
- item_array
- 64-bit address array by reference (required)
An array where each element is a 64-bit address pointing to a data
structure where information is returned. Information and its required
data type are defined by the item number passed in the corresponding
element in itemnum_array.
Array type: globalanyptr
- itemstatus_array
- record array by reference (required)
An array where each element returns the status of the operation
performed in the corresponding element in item_array. A zero indicates a
successful operation. A negative value indicates an error condition. A
positive value indicates a warning. Refer to appendix A for meanings of
status values.
Array type: status_type (Refer to appendix B.)
- reply_request_id
- 32-bit signed integer by value (required)
Passes the request ID that uniquely identifies the reply request to be
retrieved. If the value passed in reply_request_id is
greater than the total number of allocated requests on the system, an
error is returned in overall_status.
- user_id
- 32-bit signed integer by value (optional)
The user ID assigned to a vendor at the time of purchase of the
Architected Interface Facility: Operating System product. If it is not
passed, the caller must have previously called AIFACCESSON.
Default: 0
Operation Notes
AIFREPLYGET requires only a reply request ID as the input parameter.
A list of reply request IDs may be obtained by calling AIFSYSWIDEGET
with area 14000.
Item Descriptions
The following table provides detailed descriptions of item numbers and
corresponding items associated with reply information returned by
AIFREPLYGET.
Table 3-28 Reply Information Item Descriptions
| Item Number |
Item Name (Data Type) Release First Available Description |
| 14001 |
Is entry active? (B) Release 3.0
Returns true if the reply request is active, and false when the reply
request is inactive. |
| 14002 |
Process type (I32) Release 3.0
Returns the type of the process that requested the reply. Values and their
meanings are as follows:
| 1 | System process |
| 2 | User process |
|
| 14003 |
Creation time (I32) Release 3.0
Returns the time (hours/minutes/seconds/tenths of seconds) when the reply
request was created.
All fields are 0's if the request is inactive. The format returned in the
32-bit integer is the same as that returned by the CLOCK
intrinsic. The bits and their meanings are as follows:
| Bits (0:8) | The hour of the day |
| Bits (8:8) | The minute of the hour |
| Bits (16:8) | The seconds |
| Bits (24:8) | The tenths of seconds |
|
| 14004 |
Job/session number (I32) Release 3.0
Returns the job/session number for the job or session that requested the
reply. Valid only for user processes. A zero is returned for system
processes.
The format of the job/session number is as follows:
| Bits (0:2) | Job or session? (1 = Session, 2 = Job) |
| Bits (2:30) | Job or session number |
|
| 14005 |
Reply request ID (I32) Release 3.0
Returns the reply request ID of the store/restore activity. Valid only for
user processes. A zero is returned for system processes. |
| 14006 |
Message text (CA160) Release 3.0
Returns the text portion of the reply request, as it is normally displayed
on the console.
The set and message numbers of the reply request are used to fetch the
message from the message catalog. Parameters (refer to item 14011) may be
inserted into the message wherever a "!" is found. |
| 14007 |
Message source (I32) Release 3.0
Returns a value indicating the source of the message text. Values and
their meanings are as follows:
| 1 | Message catalog |
| 2 | Supplied literal |
|
| 14008 |
Message length (I32) Release 3.0
Returns the length of the message returned in item 14006. |
| 14009 |
Request set number (I16) Release 3.0
Returns the message set number in the message catalog for the specified
request. Values and their meanings are as follows:
| >0 | Message number within message set |
| -1 | String is passed in, rather than found in, the
message catalog |
|
| 14010 |
Request message number (I16) Release 3.0
The return depends on whether the message set number is greater than zero
or less than zero:
- If the message set number is greater than zero (see item 14009),
returns the message number in the message catalog for the specified
request.
- If the message set number is less than zero, returns the byte
address of the string that is passed in.
|
| 14011 |
Parameter (CA80) Release 3.0
Returns the parameters whose types are defined by item 14012 "Parameter
type."
A message can contain up to five parameters. The parameters are inserted
wherever an "!" is found in a message. Parm1 substitutes for the leftmost
parameter in the message, parm2 for the next parameter to the right, and
so on. If parm(n) is present, parm(n-1)
must also be present. If parm is a string, a byte address must be
passed. |
| 14012 |
Parameter type (REC) Release 3.0
Returns values indicating the data types of any parameters that are
returned in item 14011.
Values indicating data types are:
| 0 | Parm is the address of a byte array, terminated by
a null (0) |
| 1 | Parm is a 16-bit integer value< |
| 2 | Parm is the address of a 32-bit integer |
| 3 | Parm should be ignored |
The bits where each of the parameter type indicators are located are:
| Bits (0:1) | If set to 1, ignore all parameters |
| Bits (1:3) | Type of parm1 |
| Bits (4:3) | Type of parm2 |
| Bits (7:3) | Type of parm3 |
| Bits (10:3) | Type of parm4 |
| Bits (13:3) | Type of parm5 |
Record type: bit16 (Refer to appendix B.) |
|
