Edit

Share via

WsResetChannel function (webservices.h)

  • Article

Reset a channel so it can be reused.

Syntax

HRESULT WsResetChannel(
  [in]           WS_CHANNEL *channel,
  [in, optional] WS_ERROR   *error
);

Parameters

[in] channel

The channel to reset.

[in, optional] error

Specifies where additional error information should be stored if the function fails.

Return value

This function can return one of these values.

Return code Description
WS_E_INVALID_OPERATION
 The channel was in an inappropriate state.

Remarks

Reusing a channel instead of creating one from scratch may improve performance.

This function is only valid when the channel is in the either the WS_CHANNEL_STATE_CREATED or WS_CHANNEL_STATE_CLOSED state.

If called correctly, this function will not fail (for example, due to lack of system resources).

Requirements

Requirement Value
Minimum supported client Windows 7 [desktop apps | UWP apps]
Minimum supported server Windows Server 2008 R2 [desktop apps | UWP apps]
Target Platform Windows
Header webservices.h
Library WebServices.lib
DLL WebServices.dll