MesDecodeIncrementalHandleCreate function (midles.h)

Article
02/22/2024

The MesDecodeIncrementalHandleCreate function creates a decoding handle for the incremental style of serialization.

Syntax

RPC_STATUS MesDecodeIncrementalHandleCreate(
  void         *UserState,
  MIDL_ES_READ ReadFn,
  handle_t     *pHandle
);

Parameters

UserState

Pointer to the user-supplied state object that coordinates the user-supplied Alloc, Write, and Read functions.

ReadFn

Pointer to the Read function.

pHandle

Pointer to the newly created handle.

Return value

Value	Meaning
RPC_S_OK	The call succeeded.
RPC_S_INVALID_ARG	The argument was invalid.
RPC_S_OUT_OF_MEMORY	Out of memory.

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

Remarks

The MesDecodeIncrementalHandleCreate function is used by applications to create the handle and initialize it for the incremental style of decoding. When using the incremental style of decoding, the user supplies a Read function to provide a buffer containing the next part of the data to be decoded. The buffer must be aligned at 8, and the size of the buffer must be a multiple of 8. For additional information on the user-supplied Alloc, Write, and Read functions, see Serialization Services.

Requirements

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