CMTRTS — Test_Request_To_Send_Received


CMTRTS (conversation_ID, request_to_send_received, return_code),
        [LOGGING log_byte]

Where

conversation_ID (character input) specifies the conversation identifier of the desired conversation.

request_to_send_received (numeric output) specifies the variable containing an indication of whether or not a request-to-send notification has been received. The request_to_send_received variable can have one of the following values:

CM_REQUEST_TO_SEND_RECEIVED
CM_REQUEST_TO_SEND_NOT_RECEIVED

Unless return_code is set to CM_OK, the value of request_to_send_received is not meaningful.

return_code (numeric output) specifies the result of the statement execution.

log_byte is a 1-byte string constant or a string expression that specifies a byte of user data to be associated with this CPI-C statement during logging. The log_byte remains active until another CPI-C statement is issued. Only the first character or first two hexadecimal digits of the string expression are used. The default log_byte is X'00'.

Function

A program uses the CMTRTS statement to simulate the CPI-C CMTRTS call, which is usedto determine whether a request-to-send notification has been received from the remote program for the specified conversation.

For more information on CMTRTS and its parameters, refer to the Test_Request_To_Send_Received (CMTRTS) call description in the “Call Reference” chapter of Systems Application Architecture Common Programming Interface Communications Reference.