Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All
Expand Minimize

WsAbortListener function

Cancels any pending I/O for the specified listener.

Syntax


HRESULT WINAPI  WsAbortListener(
  _In_     WS_LISTENER* listener,
  _In_opt_ WS_ERROR*    error
);

Parameters

listener [in]

Pointer to a WS_LISTENER structure representing the listener for which to cancel I/O.

error [in, optional]

Pointer to a WS_ERROR structure that receives additional error information if the function fails.

Return value

If the function succeeds, it returns NO_ERROR; otherwise, it returns an HRESULT error code.

Remarks

WsAbortListener can be called when the listener is in any state. (See the WS_LISTENER_STATE enumeration for possible states.) If the listener is in the WS_LISTENER_STATE_OPEN state, this function will force the listener to fault (reset to the WS_LISTENER_STATE_FAULTED state). When a listener is faulted, all attempts to accept a message from it fail immediately with the WS_E_OBJECT_FAULTED error code.

This function does not wait for pending I/O to complete.

If called with valid parameters, this function will not fail for reasons such as a lack of system resources.

Requirements

Minimum supported client

Windows 7 [desktop apps only]

Minimum supported server

Windows Server 2008 R2 [desktop apps only]

Header

WebServices.h

Library

WebServices.lib

DLL

WebServices.dll

 

 

Community Additions

ADD
Show:
© 2015 Microsoft