ISyncMgrSyncItem::GetPolicies method (syncmgr.h)

Article
02/22/2024

Gets a set of flags describing the policies set by the item.

Syntax

HRESULT GetPolicies(
  [out] SYNCMGR_ITEM_POLICIES *pmPolicies
);

Parameters

[out] pmPolicies

Type: SYNCMGR_ITEM_POLICIES*

When this method returns, contains a pointer to a bitwise combination of values from the SYNCMGR_ITEM_POLICIES enumeration that defines the item's policies.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

A policy is an action that is typically supported but can be disabled by a group policy.

This method is called by Sync Center in response to a call to UpdateItem.

Examples

The following example shows an implementation of this method.

STDMETHODIMP CMyDeviceSyncItem::GetPolicies(
                              __out SYNCMGR_ITEM_POLICIES *pmPolicies)
{
    *pmPolicies = SYNCMGR_IPM_PREVENT_DISABLE 
                | SYNCMGR_IPM_HIDDEN_BY_DEFAULT;
                
    return S_OK;
}

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2008 [desktop apps only]
Target Platform	Windows
Header	syncmgr.h

Share via