WsResetMessage function

Sets the Message state back to WS_MESSAGE_STATE_EMPTY. In this state the Message object can be reused.

Syntax

HRESULT WINAPI  WsResetMessage(
  _In_     WS_MESSAGE* message,
  _In_opt_ WS_ERROR*   error
);

Parameters

message [in]

A pointer to the Message object to reset.

error [in, optional]

A pointer to a WS_ERROR object where additional information about the error should be stored if the function fails.

Return value

This function can return one of these values.

Remarks

When a message is reset, its underlying heap is reset.

Reusing a message object to receive or send multiple messages is is generally more efficient than creating and free'ing the message object for each message.

Requirements