Test_Request_To_Send_Received

The Test_Request_To_Send_Received call (function name cmtrts) determines whether a request-to-send notification has been received from the partner program.

CM_ENTRY Test_Request_To_Send_Received(
  unsigned char FAR *conversation_ID,  
  CM_INT32 FAR *request_to_send_received,  
  CM_INT32 FAR *return_code            
);
 

Parameters

conversation_ID

Supplied parameter. Specifies the identifier for the conversation. The value of this parameter was returned by Initialize_Conversation or Accept_Conversation.

request_to_send_received

Returned parameter. The request-to-send-received indicator. Possible values are:

CM_REQ_TO_SEND_RECEIVED

The partner program issued Request_To_Send, which requests the local program to change the conversation to RECEIVE state.

CM_REQ_TO_SEND_NOT_RECEIVED

The partner program did not issue Request_To_Send. This value is not relevant if return_code contains a value other than cm_ok.

return_code

The code returned from this call. The valid return codes are listed below.

Return Codes

cm_ok

Primary return code; the call executed successfully.

cm_program_parameter_check

Primary return code; the value specified by conversation_ID is invalid, or the address of a variable is invalid.

cm_program_state_check

Primary return code; the conversation is in a state other than SEND, RECEIVE, or SEND_PENDING.

cm_product_specific_error

Primary return code; a product-specific error occurred and has been logged in the product's error log.

State Changes

The conversation must be in SEND, RECEIVE, or SEND_PENDING state.

There is no state change.