GET_STATE

The GET_STATE verb returns the state of a particular conversation.

The following structure describes the verb control block used by the GET_STATE verb.

struct get_state {
    unsigned short   opcode;
    unsigned char    opext;
    unsigned char    reserv2;
    unsigned short   primary_rc;
    unsigned long    secondary_rc;
    unsigned char    tp_id[8];
    unsigned long    conv_id;
    unsigned char    conv_state;
};

Members

opcode
Supplied parameter. Specifies the verb operation code, AP_GET_STATE.
opext
This field is unused by the GET_STATE verb.
primary_rc
Returned parameter. Specifies the primary return code set by APPC at the completion of the verb. The valid return codes vary depending on the APPC verb issued. See Return Codes for valid error codes for this verb.
secondary_rc
Returned parameter. Specifies the secondary return code set by APPC at the completion of the verb. The valid return codes vary depending on the APPC verb issued. See Return Codes for valid error codes for this verb.
tp_id
Supplied parameter. Identifies the local TP. The value of this parameter was returned by TP_STARTED in the invoking TP or by RECEIVE_ALLOCATE in the invoked TP.
conv_id
Supplied parameter. Provides the identifier for the conversation about which this TP is inquiring. The value of this parameter was returned by MC_ALLOCATE or ALLOCATE in the invoking TP or by RECEIVE_ALLOCATE in the invoked TP.
conv_state
Returned parameter. Indicates the state of the conversation. The conv_state parameter can be one of the following values:
AP_RESET_STATE
The conversation is in the RESET state.
AP_SEND_STATE
The conversation is in the SEND state.
AP_RECEIVE_STATE
The conversation is in the RECEIVE state.
AP_CONFIRM_STATE
The conversation is in the CONFIRM state.
AP_CONFIRM_SEND_STATE
The conversation is in the CONFIRM_SEND state.
AP_CONFIRM_DEALL_STATE
The conversation is in the CONFIRM_DEALLOCATE state.
AP_PEND_POST_STATE
The conversation has a POST verb pending.
AP_PEND_DEALL_STATE
The conversation has a DEALLOCATE verb pending.
AP_END_CONV_STATE
The conversation is in the END_CONVERSATION state.
AP_SEND_PENDING_STATE
The conversation is in the SEND_PENDING state.

Return Codes

ap_ok
Primary return code; the verb executed successfully.
ap_parameter_check
Primary return code; the verb did not execute because of a parameter error.
ap_bad_conv_id
Secondary return code; the value of conv_id did not match a conversation identifier assigned by APPC.
ap_bad_tp_id
Secondary return code; the value of tp_id did not match a TP identifier assigned by APPC.
AP_COMM_SUBSYSTEM_ABENDED
Primary return code; indicates one of the following conditions:

The system administrator should examine the error log to determine the reason for the ABEND.

ap_invalid_verb_segment
Primary return code; the VCB extended beyond the end of the data segment.
ap_stack_too_small
Primary return code; the stack size of the application is too small to execute the verb. Increase the stack size of your application.
ap_conv_busy
Primary return code; there can only be one outstanding conversation verb at a time on any conversation. This can occur if the local TP has multiple threads, and more than one thread is issuing APPC calls using the same conv_id.
ap_unexpected_dos_error
Primary return code; the operating system has returned an error to APPC while processing an APPC call from the local TP. The operating system return code is returned through the secondary_rc. It appears in Intel byte-swapped order. If the problem persists, consult the system administrator.

Remarks

The conversation can be in any state when the TP issues this verb.

There is no state change.