ISyncMgrSyncItem::GetItemInfo method (syncmgr.h)

Article
02/22/2024

Gets the properties of a sync item.

Syntax

HRESULT GetItemInfo(
  [out] ISyncMgrSyncItemInfo **ppItemInfo
);

Parameters

[out] ppItemInfo

Type: ISyncMgrSyncItemInfo*

When this method returns, contains the address of a pointer to an instance of the ISyncMgrSyncItemInfo interface, representing the item.

Return value

Type: HRESULT

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

Remarks

If GetItemInfo fails, the sync item is still shown in the handler's folder and Sync Center continues to synchronize it, but default values are used for all properties.

Examples

The following example shows an implementation of this method.

STDMETHODIMP CMyDeviceSyncItem::GetItemInfo(
                              __out ISyncMgrSyncItemInfo **ppItemInfo)
{
    *ppItemInfo = NULL;
    
    HRESULT hr = QueryInterface(IID_ISyncMgrSyncItemInfo, (void**)ppItemInfo);
    return hr;
}

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