MesEncodeIncrementalHandleCreate

The MesEncodeIncrementalHandleCreate function creates an encoding and then initializes it for the incremental style of serialization.

#include <rpc.h>
#include <midles.h>
RPC_STATUS RPC_ENTRY MesEncodeIncrementalHandleCreate( 
  void *  UserState,    
  MIDL_ES_ALLOC  AllocFn,   
  MIDL_ES_WRITE  WriteFn,   
  handle_t  *  pHandle  
);
 

Parameters

UserState
Points to the user-supplied state object that coordinates the Alloc, Write, and Read routines.
AllocFn
Points to the Alloc routine.
WriteFn
Points to the Write routine.
pHandle
Points to the newly-created handle.

Remarks

The MesEncodeIncrementalHandleCreate routine is used by applications to create and initialize the handle for the incremental style of encoding or decoding. When using the incremental style of encoding, the user supplies an Alloc routine to provide an empty buffer into which the encoded data is placed, and a Write routine to call when the buffer is full or the encoding is complete. For additional information on the user-supplied Alloc, Write and Read routines, see Using Encoding Services.

Return Values

Value Meaning
RPC_S_OK Success
RPC_S_INVALID_ARG Invalid argument
RPC_S_OUT_OF_MEMORY Out of memory

QuickInfo

  Windows NT: Yes
  Windows CE: Unsupported.
  Header: Declared in midles.h.
  Import Library: Link with rpcrt4.lib.

See Also

MesIncrementalHandleReset, MesHandleFree