rpc_sm_client_free, rpc_ss_client_free(3c)

Name

rpc_sm_client_free(), rpc_ss_client_free()—Frees memory returned from a client stub.

Synopsis

#include <rpc/rpc.h> 
void rpc_sm_client_free (idl_void_p_t node_to_free, unsigned32 *status)
void rpc_ss_client_free (idl_void_p_t node_to_free)

Description

The rpc_sm_client_free() routine releases memory allocated and returned from a client stub. The input parameter, node_to_free, specifies a pointer to memory returned from a client stub. Note that in the ISO standard C environments, idl_void_p_t is defined as void * and in other environments is defined as char *.

This routine enables a routine to deallocate dynamically allocated memory returned by an RPC call without knowledge of the memory management environment from which it was called.

Note that this routine is always called from client code, even if the code can is executing as part of a server.

The output parameter, status, returns the status code from this routine. This status code indicates whether the routine completed successfully or, if not, why not. Possible status codes and their meanings include:

rpc_ss_client_free() is the exception-returning version of this function and has no status output parameter. No exceptions are raised.

A thread in a multithreaded application may issue a call to rpc_sm_client_free() or rpc_ss_client_free() while running in any context state, including TPINVALIDCONTEXT.

Return Values

None.

See Also

Programming BEA Tuxedo ATMI Applications Using TxRPC