otma_close API

The otma_close API is called to free storages for communication and to leave the z/OS® cross-system coupling facility (XCF) group. This function may be called when communications are in flight or an open is processing. In these cases all relevant ECBs will be posted with a canceled post code.

Invocation

Called by the client in TCB mode.

Input

*anchor: Pointer to anchor word returned by otma_open.

Output

*anchor: Pointer to anchor word returned by otma_open.
*retrsn: Pointer to return code.

C-language function prototype

otma_close(
     otma_anchor_t  *anchor,  [in/out]
     otma_retrsn_t   *retrsn); [out]

Return values (rc value)

The rc and reason are valid after ECB has been posted. For the complete description of each error, see IMS Version 15.5 Communications and Connections.

0: Success.
4: Null anchor.
8: Cannot leave the XCF group.