DEACTIVATE_CONV_GROUP

The DEACTIVATE_CONV_GROUP verb requests the deactivation of the session corresponding to the specified conversation group. Although this verb is part of the Node Operator Facility API, it is primarily intended for use by application programmers writing transaction programs that use the Personal Communications or Communications Server APPC API. The conversation group identifier is returned by the MC_ALLOCATE, ALLOCATE, MC_GET_ATTRIBUTES, GET_ATTRIBUTES and RECEIVE_ALLOCATE verbs defined in Client/Server Communications Programming.

VCB Structure

typedef struct deactivate_conv_group
{
        unsigned short  opcode;         /* verb operation code           */
        unsigned char   reserv2;        /* reserved                      */
        unsigned char   format;         /* format                        */
        unsigned short  primary_rc;     /* primary return code           */
        unsigned long   secondary_rc;   /* secondary return code         */
        unsigned char   lu_name[8];     /* local LU name                 */
        unsigned char   lu_alias[8];    /* local LU alias                */
        unsigned long   conv_group_id;  /* conversation group identifier */
        unsigned char   type;           /* deactivation type             */
        unsigned char   reserv3[3];     /* reserved                      */
        unsigned long   sense_data;     /* deactivation sense data       */
} DEACTIVATE_CONV_GROUP;

Supplied Parameters

The application supplies the following parameters:
opcode
AP_DEACTIVATE_CONV_GROUP
format
Identifies the format of the VCB. Set this field to zero to specify the version of the VCB listed above.
lu_name
LU name of the local LU requested to deactivate the conversation group. This name is an 8-byte type-A EBCDIC character string. If this field is set to all zeros, the lu_alias field will be used for determining the local LU.
lu_alias
Alias of the local LU requested to deactivate the conversation group. This is an 8-byte string in a locally displayable character set. This field is only significant if the lu_name field is set to all zeros, in which case all 8 bytes are significant and must be set. If both the lu_name and lu_alias are set to all zeros, the verb is forwarded to the LU associated with the control point (the default LU).
conv_group_id
Conversation group identifier for the session to be deactivated.
type
Type of deactivation. This field is a bitmask consisting of a deactivation type ORed with a flag indicating whether the verb should complete asynchronously or synchronously.

Deactivation types:

AP_DEACT_CLEANUP
The session is terminated immediately, without waiting for a response from the partner LU.
AP_DEACT_NORMAL
The session terminates after all conversations using the session are ended.

Verb behavior:

AP_ASYNCHRONOUS_DEACTIVATION
The verb returns immediately.
AP_SYNCHRONOUS_DEACTIVATION
The verb returns only after the session has been deactivated.
sense_data
Specifies the sense data for use in the CLEANUP type of deactivation.

Returned Parameters

If the verb executes successfully, the Program returns the following parameter:
primary_rc
AP_OK
If the verb does not execute because of a parameter error, the Program returns the following parameters:
primary_rc
AP_PARAMETER_CHECK
secondary_rc
AP_INVALID_CLEANUP_TYPE

AP_INVALID_LU_NAME
AP_INVALID_LU_ALIAS

If the verb does not execute because the node has not yet been started, the Program returns the following parameter:
primary_rc
AP_NODE_NOT_STARTED
If the verb does not execute because the node is stopping, the Program returns the following parameter:
primary_rc
AP_NODE_STOPPING
If the verb does not execute because of a system error, the Program returns the following parameter:
primary_rc
AP_UNEXPECTED_SYSTEM_ERROR