CMFLUS — Flush


CMFLUS (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 CMFLUS statement to simulate the CPI-C CMFLUS call, which is usedto empty the local logical unit's send buffer for a given conversation. When notified by CPI Communications that a CMFLUS has been issued, the LU sends any information it has buffered to the remote LU. The information that can be buffered comes from the CMALLC, CMSEND, or CMSERR statement. For more details of when and how buffering occurs, refer to the call descriptions of those calls in the “Call Reference” chapter of Systems Application Architecture Common Programming Interface Communications Reference.

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