WsAbortServiceProxy function

Aborts the service proxy, and cancels any pending I/O on the service proxy.

Syntax

HRESULT WINAPI  WsAbortServiceProxy(
  _In_     WS_SERVICE_PROXY* serviceProxy,
  _In_opt_ WS_ERROR*         error
);

Parameters

serviceProxy [in]

Pointer to a WS_SERVICE_PROXY structure representing the service proxy to abort.

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

WsAbortServiceProxy shows the following behavior depending on the state of service proxy (see the WS_SERVICE_PROXY_STATE enumeration for possible states):

• If the service proxy is opening and in the WS_SERVICE_PROXY_STATE_OPENING state, you can call WsAbortServiceProxy to abort the opening operation. The service proxy will cancel all pending I/O and transition back to WS_SERVICE_PROXY_STATE_CREATED state.
• If the service proxy is already open and in the WS_SERVICE_PROXY_STATE_OPEN state, WsAbortServiceProxy will cause the service proxy to abort all underlying channels and transition to the WS_SERVICE_PROXY_STATE_FAULTED state. Once the abort is initiated, the service proxy will not accept any new calls. The application can call WsCloseServiceProxy to close it
• If the service proxy is closing and in the WS_SERVICE_PROXY_STATE_CLOSING state, all underlying channels are aborted, and the service proxy tansitions to the WS_SERVICE_PROXY_STATE_CLOSED state.

For an example of using this function, see ServiceCancellationExample.

Requirements