Edit

ISyncMgrHandlerInfo::GetType method (syncmgr.h)

  • Article

Gets the handler type for Sync Center.

Syntax

HRESULT GetType(
  [out] SYNCMGR_HANDLER_TYPE *pnType
);

Parameters

[out] pnType

Type: SYNCMGR_HANDLER_TYPE*

When this method returns, points to a value from the SYNCMGR_HANDLER_TYPE enumeration that specifies the handler type. If the method fails, this parameter points to SYNCMGR_HT_UNSPECIFIED.

Return value

Type: HRESULT

Returns S_OK if successful, or an error value otherwise. If the method fails, pnType is set to SYNCMGR_HT_UNSPECIFIED.

Remarks

Typically, this value does not change. However, Sync Center calls this method whenever the UpdateHandler method is called.

Examples

The following example shows an implementation of this method.

STDMETHODIMP CMyDeviceHandler::GetType(__out SYNCMGR_HANDLER_TYPE *pnType)
{
    *pnType = SYNCMGR_HT_DEVICE;
    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