Windows apps
Collapse the table of content
Expand the table of content
Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

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.

Return codeDescription
E_INVALIDARG

One or more arguments are invalid.

 

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

Minimum supported client

Windows 7 [desktop apps | Windows Store apps]

Minimum supported server

Windows Server 2008 R2 [desktop apps | Windows Store apps]

Header

WebServices.h

Library

WebServices.lib

DLL

WebServices.dll

 

 

Community Additions

Show:
© 2017 Microsoft