otma_free API

The otma_free API is called to free an independent session created by otma_alloc.

Invocation

Called by the client in TCB mode.

Input

*anchor: Pointer to anchor word returned by otma_open.
*session_handle: Pointer to session handle returned by otma_alloc.

Output

*retrsn: Pointer to return code structure.
*session_handle: Pointer to session handle will be nulled by otma_free.

C-language function prototype

otma_free(
   otma_anchor_t  *anchor,          [in]
   otma_retrsn_t  *retrsn,          [out]
   sess_handle_t  *session_handle); [in/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.3 Communications and Connections.

0: Success.
4: Not allocated session.
8: Incorrect anchor.