Edit

Share via

WsGetServiceProxyProperty function (webservices.h)

  • Article

This function retrieves a specified Service Proxy property. The property to retrieve is identified by a WS_PROXY_PROPERTY_ID input parameter.

Syntax

HRESULT WsGetServiceProxyProperty(
  [in]           WS_SERVICE_PROXY           *serviceProxy,
  [in]           const WS_PROXY_PROPERTY_ID id,
                 void                       *value,
  [in]           ULONG                      valueSize,
  [in, optional] WS_ERROR                   *error
);

Parameters

[in] serviceProxy

This parameter is a pointer to the WS_SERVICE_PROXY object containing the property to retrieve.

[in] id

The value of this parameter is a WS_PROXY_PROPERTY_ID enumerator value that identifies the property to retrieve.

value

This parameter is a reference to a location for storing the retrieved property value. The pointer must have an alignment compatible with the type of the property.

[in] valueSize

The value of this ULONG parameter represents the byte-length buffer size allocated by the caller to store the retrieved property value.

[in, optional] error

This parameter is a WS_ERROR pointer to 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
E_INVALIDARG
 The property id was not supported for this object.

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