[MC_]TEST_RTS

The [MC_]TEST_RTS verb determines whether a request-to-send notification has been received from the partner transaction program.

VCB Structure

typedef struct test_rts
{
 unsigned short     opcode;              /* verb operation code     */
 unsigned char      opext;               /* verb extension code     */
 unsigned char      format;              /* format                  */
 unsigned short     primary_rc;          /* primary return code     */
 unsigned long      secondary_rc;        /* secondary return code   */
 unsigned char      tp_id[8];            /* TP identifier           */
 unsigned long      conv_id;             /* conversation identifier */
 unsigned char      reserv3;             /* reserved                */
} TEST_RTS;
typedef struct mc_test_rts
{
 unsigned short    opcode;             /* verb operation code     */
 unsigned char     opext;              /* verb extension code     */
 unsigned char     format;             /* format                  */
 unsigned short    primary_rc;         /* primary return code     */
 unsigned long     secondary_rc;       /* secondary return code   */
 unsigned char     tp_id[8];           /* TP identifier           */
 unsigned long     conv_id;            /* conversation identifier */
 unsigned char     reserv3;            /* reserved                */
} MC_TEST_RTS;

Supplied Parameters

The transaction program supplies the following parameters to Personal Communications:
opcode
AP_B_TEST_RTS
Displays a basic verb icon.

AP_M_TEST_RTS

Displays a mapped verb icon.

opext
AP_BASIC_CONVERSATION or AP_MAPPED_CONVERSATION
format
Identifies the format of the VCB. Set this field to zero to specify the version of the VCB listed above.
tp_id
Identifier for the local transaction program. The value of this parameter was returned by the TP_STARTED verb in the invoking transaction program or by RECEIVE_ALLOCATE in the invoked transaction program.
conv_id
Conversation identifier.

The value of this parameter was returned by the [MC_]ALLOCATE verb in the invoking transaction program or by RECEIVE_ALLOCATE in the invoked transaction program.

Returned Parameters

If the verb executes successfully, Personal Communications returns the following parameter:
primary_rc
Indicates whether a request-to-send notification has been received from the partner transaction program.
  • AP_OK
  • AP_UNSUCCESSFUL
If the verb does not execute because of a parameter error, Personal Communications returns the following parameters:
primary_rc
AP_PARAMETER_CHECK
secondary_rc
AP_BAD_CONV_ID

AP_BAD_TP_ID
AP_TEST_INVALID_FOR_FDX

The conditions generating the following possible primary return codes (primary_rc) are described in APPC Common Return Codes.

AP_TP_BUSY
AP_CONVERSATION_TYPE_MIXED
AP_UNEXPECTED_SYSTEM_ERROR