WsResetChannel function

Reset a channel so it can be reused.

Syntax

HRESULT WINAPI  WsResetChannel(
  _In_     WS_CHANNEL* channel,
  _In_opt_ WS_ERROR*   error
);

Parameters

channel [in]

The channel to reset.

error [in, optional]

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

Return value

This function can return one of these values.

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