Edit

WsGetPolicyProperty function (webservices.h)

  • Article

Retrieves a property of a policy object.

Syntax

HRESULT WsGetPolicyProperty(
  [in]           WS_POLICY             *policy,
  [in]           WS_POLICY_PROPERTY_ID id,
                 void                  *value,
  [in]           ULONG                 valueSize,
  [in, optional] WS_ERROR              *error
);

Parameters

[in] policy

A pointer to the WS_POLICY object from which to obtain the property.

[in] id

An identifier of the policy property to retrieve.

value

A pointer to the address to store the retrieved property value. The pointer must have an alignment compatible with the type of the property.

[in] valueSize

The number of bytes allocated by the caller to store the retrieved property.

[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
E_INVALIDARG
 The property id was not supported for this object or the specified buffer was not large enough for the value.
E_OUTOFMEMORY
 Ran out of memory.
Other Errors
This function may return other errors not listed above.

Remarks

The data returned by this function is good until the metadata object is freed or reset.

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