CMPTR — Prepare_To_Receive

CMPTR (conversation_ID, return_code) [LOGGING log_byte]

Where

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

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 CMPTR statement to simulate the CPI-C CMPTR call, which is used to change the conversation from Send to Receive state in preparation for receiving data. The change to Receive state can be either completed as part of this statement or deferred until the program issues a CMFLUS or CMCFM statement. When the change to Receive state is completed as part of this statement, it may include the function of the CMFLUS or CMCFM statement. This statement's function is determined by the value of the prepare_to_receive_type conversation characteristic. See CMSPTR — Set_Prepare_To_Receive_Type for more information about the prepare_to_receive_type conversation characteristic.

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