ISyncMgrControl::UpdateHandler-Methode (syncmgr.h)

Artikel
03/02/2024

Weist das Synchronisierungscenter an, die von einem Handler verwalteten Elemente erneut aufzulisten, oder informiert es darüber, dass sich die Eigenschaften des Handlers geändert haben.

Syntax

HRESULT UpdateHandler(
  [in] LPCWSTR               pszHandlerID,
  [in] SYNCMGR_CONTROL_FLAGS nControlFlags
);

Parameter

[in] pszHandlerID

Typ: LPCWSTR

Ein Zeiger auf einen Puffer, der die eindeutige ID des Handlers enthält. Diese Zeichenfolge hat eine maximale Länge MAX_SYNCMGR_ID einschließlich des beendenden NULL-Zeichens .

[in] nControlFlags

Typ: SYNCMGR_CONTROL_FLAGS

Ein Wert aus der SYNCMGR_CONTROL_FLAGS Enumeration, die angibt, ob das Update synchron oder asynchron ausgeführt werden soll.

Rückgabewert

Typ: HRESULT

Wenn diese Methode erfolgreich ist, wird S_OK zurückgegeben. Andernfalls wird ein Fehlercode HRESULT zurückgegeben.

Hinweise

Wenn SYNCMGR_CF_WAIT im nControlFlags-Parameter festgelegt ist, wird UpdateHandler erst zurückgegeben, wenn das Sync Center den angegebenen Handler geladen und alle Handler- und Elementinformationen neu geladen hat. Wenn der Handler von einer Handlerauflistung bereitgestellt wird, wird auch die Handlerauflistung geladen, um den Handler neu zu laden.

Beispiele

Das folgende Beispiel zeigt die Verwendung von ISyncMgrControl::UpdateHandler durch die Prozedur eines Handlers.

void CMyDeviceHandler::MiscProc(...)
{
    ...

    // Get the Sync Center control object.
    ISyncMgrControl *pControl = NULL;
    
    hr = CoCreateInstance(CLSID_SyncMgrControl, 
                          CLSCTX_SERVER, 
                          IID_PPV_ARGS(&pControl));
    if (SUCCEEDED(hr))
    {
        // Tell Sync Center that properties on the handler have changed.
        hr = pControl->UpdateHandler(s_szMySyncHandlerID, SYNCMGR_CF_WAIT);
        pControl->Release();
    }

    ...

}

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows Vista [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows Server 2008 [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	syncmgr.h

Freigeben über