Export (0) Print
Expand All
Expand Minimize

WsAbandonCall function

Abandons a specified call on the specified service proxy.

Syntax


HRESULT WINAPI  WsAbandonCall(
  _In_      WS_SERVICE_PROXY* serviceProxy,
  _In_      ULONG callId,
  _In_opt_  WS_ERROR* error
);

Parameters

serviceProxy [in]

Pointer to a WS_SERVICE_PROXY structure representing the service proxy on which to abandon the call.

callId [in]

ID of the call to abandon. (See the Remarks section.)

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.

Return codeDescription
WS_E_INVALID_OPERATION

The current state of the service proxy is not valid for this operation.

E_INVALIDARG

A NULL service proxy was passed to the function.

 

Remarks

Calls are identified by a call ID. This call ID is associated with the call by the WS_CALL_PROPERTY_CALL_ID value of the WS_CALL_PROPERTY_ID enumeration.

If the call ID is 0, all pending calls on the service proxy are abandoned. For more information, see the following topics:

Be aware that the actual I/O associated with the call is not canceled. The service proxy keeps the resources to complete the call even though the call was abandoned.

This results in a consumption of resources that is aggravated if an application continues to abandon calls, as can happen when the server is slow to respond to the client, and the client application abandons one call only to make the same call again.

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

ADD
Show:
© 2014 Microsoft