ISyncMgrHandler::GetCapabilities method (syncmgr.h)

Article
02/22/2024

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

Syntax

HRESULT GetCapabilities(
  [out] SYNCMGR_HANDLER_CAPABILITIES *pmCapabilities
);

Parameters

[out] pmCapabilities

Type: SYNCMGR_HANDLER_CAPABILITIES*

When this method returns, contains a pointer to a bitwise combination of values from the SYNCMGR_HANDLER_CAPABILITIES enumeration that defines the capabilities of the handler. Compare against SYNCMGR_HCM_VALID_MASK to verify a valid value.

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 UpdateHandler or UpdateHandlerCollection.

Examples

The following example shows an implementation of this method.

STDMETHODIMP CMyDeviceHandler::GetCapabilities(
                             __out SYNCMGR_HANDLER_CAPABILITIES *pmCapabilities)
{
    *pmCapabilities = SYNCMGR_HCM_EVENT_STORE
                    | SYNCMGR_HCM_QUERY_BEFORE_ACTIVATE;
    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