WsGetServiceHostProperty function (webservices.h)

Retrieves a specified Service Host property. The property to retrieve is identified by a WS_SERVICE_PROPERTY_ID input parameter.


HRESULT WsGetServiceHostProperty(
  [in]           WS_SERVICE_HOST              *serviceHost,
  [in]           const WS_SERVICE_PROPERTY_ID id,
                 void                         *value,
  [in]           ULONG                        valueSize,
  [in, optional] WS_ERROR                     *error


[in] serviceHost

A pointer to the WS_SERVICE_HOST object containing the property to retrieve.

[in] id

This is a WS_SERVICE_PROPERTY_ID enumerator value that identifies the property to retrieve.


A void pointer 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 byte-length buffer size allocated by the caller to store the retrieved property value.

[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
The property id was not supported for this object or the specified buffer was not large enough for the value.


Minimum supported client Windows 7 [desktop apps only]
Minimum supported server Windows Server 2008 R2 [desktop apps only]
Target Platform Windows
Header webservices.h
Library WebServices.lib
DLL WebServices.dll