RpcStringFreeW function (rpcdce.h)

Article
02/22/2024

The RpcStringFree function frees a character string allocated by the RPC run-time library.

Syntax

RPC_STATUS RpcStringFreeW(
  RPC_WSTR *String
);

Parameters

String

Pointer to a pointer to the character string to free.

Return value

Value	Meaning
RPC_S_OK	The call succeeded.

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

Remarks

An application is responsible for calling RpcStringFree once for each character string allocated and returned by calls to other RPC run-time library routines.

Note

The rpcdce.h header defines RpcStringFree as an alias which automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

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	rpcdce.h (include Rpc.h)
Library	Rpcrt4.lib
DLL	Rpcrt4.dll