RpcSmSetClientAllocFree function (rpcndr.h)

Article
04/02/2021

The RpcSmSetClientAllocFree function enables the memory allocation and release mechanisms used by the client stubs.

Syntax

RPC_STATUS RpcSmSetClientAllocFree(
  RPC_CLIENT_ALLOC *ClientAlloc,
  RPC_CLIENT_FREE  *ClientFree
);

Parameters

ClientAlloc

Function used to allocate memory.

ClientFree

Function used to release memory and used with the function specified by pfnAllocate.

Return value

Value	Meaning
RPC_S_OK	The call succeeded.
RPC_S_OUT_OF_MEMORY	The system is out of memory.

Note For a list of valid error codes, see RPC Return Values.

Remarks

By overriding the default routines used by the client stub to manage memory, RpcSmSetClientAllocFree establishes the memory allocation and memory-freeing mechanisms. Note that the default routines are free and malloc, unless the remote call occurs within manager code. In this case, the default memory–management functions are RpcSmFree and RpcSmAllocate.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps \| UWP apps]
Minimum supported server	Windows 2000 Server [desktop apps \| UWP apps]
Target Platform	Windows
Header	rpcndr.h (include Rpc.h)
Library	Rpcrt4.lib
DLL	Rpcrt4.dll