ISyncMgrSyncItem::GetCapabilities method (syncmgr.h)

Article
02/22/2024

Gets a set of flags describing the item's defined capabilities.

Syntax

HRESULT GetCapabilities(
  [out] SYNCMGR_ITEM_CAPABILITIES *pmCapabilities
);

Parameters

[out] pmCapabilities

Type: SYNCMGR_ITEM_CAPABILITIES*

When this method returns, contains a pointer to a bitwise combination of values from the SYNCMGR_ITEM_CAPABILITIES enumeration that defines the capabilities of the item.

Return value

Type: HRESULT

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

Remarks

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::GetCapabilities(
                              __out SYNCMGR_ITEM_CAPABILITIES *pmCapabilities)
{
    *pmCapabilities = SYNCMGR_ICM_EVENT_STORE
                    | SYNCMGR_ICM_CAN_DELETE
                    | SYNCMGR_ICM_QUERY_BEFORE_DELETE;
    
    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