Windows Dev Center

Expand Minimize

WsGetPolicyProperty function

Retrieves a property of a policy object.

Syntax


HRESULT WINAPI  WsGetPolicyProperty(
  _In_     WS_POLICY*            policy,
  _In_     WS_POLICY_PROPERTY_ID id,
           void*                 value,
  _In_     ULONG                 valueSize,
  _In_opt_ WS_ERROR*             error
);

Parameters

policy [in]

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

id [in]

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.

valueSize [in]

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

error [in, optional]

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 codeDescription
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

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:
© 2015 Microsoft