ISyncMgrHandler::GetHandlerInfo method (syncmgr.h)

Article
02/22/2024

Gets properties that describe the handler.

Syntax

HRESULT GetHandlerInfo(
  [out] ISyncMgrHandlerInfo **ppHandlerInfo
);

Parameters

[out] ppHandlerInfo

Type: ISyncMgrHandlerInfo**

When this method returns, contains the address of a pointer to an instance of the ISyncMgrHandlerInfo interface that provides access to the handler properties.

Return value

Type: HRESULT

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

Remarks

If this method fails, the handler is still shown in the Sync Center folder and Sync Center continues to invoke it, but default values are used for all properties.

ISyncMgrHandler::GetHandlerInfo, together with ISyncMgrHandler::GetName, replaces the older GetHandlerInfo.

Examples

The following example shows an implementation of this method.

STDMETHODIMP CMyDeviceHandler::GetHandlerInfo(
                             __out ISyncMgrHandlerInfo **ppHandlerInfo)
{
    *ppHandlerInfo = NULL;
    HRESULT hr = QueryInterface(IID_ISyncMgrHandlerInfo, 
                                (void **) ppHandlerInfo);
    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