Edit

Share via

WsOpenServiceProxy function (webservices.h)

  • Article

Opens a Service Proxy to a Service endpoint.

On success client applications can make calls using the Service Proxy. The behavior of WsOpenServiceProxy is governed by the channel binding used.

Syntax

HRESULT WsOpenServiceProxy(
  [in]           WS_SERVICE_PROXY          *serviceProxy,
  [in]           const WS_ENDPOINT_ADDRESS *address,
  [in, optional] const WS_ASYNC_CONTEXT    *asyncContext,
  [in, optional] WS_ERROR                  *error
);

Parameters

[in] serviceProxy

A pointer to the Service Proxy to open. The pointer must reference a valid WS_SERVICE_PROXY object and the referenced value may not be NULL.

[in] address

A pointer to the address of the endpoint.

[in, optional] asyncContext

A pointer to A WS_ASYNC_CONTEXT object that has information about how to invoke the function asynchronously. The value is set to NULL if invoking synchronously.

[in, optional] error

A pointer to a WS_ERROR object where additional information about the error should be stored if the function fails.

Return value

This function can return one of these values.

Return code Description
WS_S_ASYNC
 The asynchronous operation is still pending.
WS_E_OPERATION_ABORTED
 The operation was aborted.
WS_E_INVALID_OPERATION
 The operation is not allowed due to the current state of the object.
WS_E_ENDPOINT_NOT_FOUND
 The remote endpoint does not exist or could not be located.
WS_E_ENDPOINT_ACCESS_DENIED
 Access was denied by the remote endpoint.
WS_E_ENDPOINT_DISCONNECTED
 The connection with the remote endpoint was terminated.
WS_E_ENDPOINT_FAILURE
 The remote endpoint could not process the request.
WS_E_ENDPOINT_NOT_AVAILABLE
 The remote endpoint is not currently in service at this location.
WS_E_ENDPOINT_TOO_BUSY
 The remote endpoint is unable to process the request due to being overloaded.
WS_E_ENDPOINT_UNREACHABLE
 The remote endpoint was not reachable.
WS_E_INVALID_ENDPOINT_URL
 The endpoint address URL is invalid.
WS_E_INVALID_FORMAT
 The input data was not in the expected format or did not have the expected value.
WS_E_OPERATION_TIMED_OUT
 The operation did not complete within the time allotted.
WS_E_PROXY_ACCESS_DENIED
 Access was denied by the HTTP proxy server.
WS_E_PROXY_FAILURE
 The HTTP proxy server could not process the request.
WS_E_QUOTA_EXCEEDED
 A quota was exceeded.
WS_E_SECURITY_VERIFICATION_FAILURE
 Security verification was not successful for the received data.
WS_E_SECURITY_SYSTEM_FAILURE
 A security operation failed in the Windows Web Services framework.
WS_E_PROXY_REQUIRES_BASIC_AUTH
 The HTTP proxy server requires HTTP authentication scheme 'basic'.
WS_E_PROXY_REQUIRES_DIGEST_AUTH
 The HTTP proxy server requires HTTP authentication scheme 'digest'.
WS_E_PROXY_REQUIRES_NEGOTIATE_AUTH
 The HTTP proxy server requires HTTP authentication scheme 'negotiate'.
WS_E_PROXY_REQUIRES_NTLM_AUTH
 The HTTP proxy server requires HTTP authentication scheme 'NTLM'.
WS_E_SERVER_REQUIRES_BASIC_AUTH
 The remote endpoint requires HTTP authentication scheme 'basic'.
WS_E_SERVER_REQUIRES_DIGEST_AUTH
 The remote endpoint requires HTTP authentication scheme 'digest'.
WS_E_SERVER_REQUIRES_NEGOTIATE_AUTH
 The remote endpoint requires HTTP authentication scheme 'negotiate'.
WS_E_SERVER_REQUIRES_NTLM_AUTH
 The remote endpoint requires HTTP authentication scheme 'NTLM'.
E_OUTOFMEMORY
 Ran out of memory.
E_INVALIDARG
 One or more arguments are invalid.
Other Errors
This function may return other errors not listed above.

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