ISyncMgrControl::ActivateHandler-Methode (syncmgr.h)

Artikel
03/04/2024

Aktiviert oder deaktiviert einen Handler.

Syntax

HRESULT ActivateHandler(
  [in] BOOL                  fActivate,
  [in] LPCWSTR               pszHandlerID,
  [in] HWND                  hwndOwner,
  [in] SYNCMGR_CONTROL_FLAGS nControlFlags
);

Parameter

[in] fActivate

Typ: BOOL

TRUE , um zu aktivieren; Zu deaktivierende FALSE .

[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 endenden NULL-Zeichens .

[in] hwndOwner

Typ: HWND

Ein Handle für ein Fenster, das vom Handler verwendet werden kann, um jede erforderliche Benutzeroberfläche anzuzeigen. Dieser Wert kann NULL sein.

[in] nControlFlags

Typ: SYNCMGR_CONTROL_FLAGS

Ein Wert aus der SYNCMGR_CONTROL_FLAGS Enumeration, die angibt, ob die Aktivierung oder Deaktivierung des Handlers 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

Im Ordner "Synchronisierungscenter" wird ein aktiver Handler angezeigt. ein inaktiver Handler wird im Ordner Sync Setup angezeigt.

Wenn der angegebene Handler SYNCMGR_HCM_QUERY_BEFORE_ACTIVATE oder SYNCMGR_HCM_QUERY_BEFORE_DEACTIVATE in der von der GetCapabilities-Methode zurückgegebenen Maske zurückgibt, wird der Abfragevorgang angefordert, bevor der Handler aktiviert oder deaktiviert wird. Wenn keine Abfrageoberfläche angefordert wird oder der Benutzer den Vorgang bestätigt, wird die Activate-Methode des Handlers aufgerufen.

Wenn SYNCMGR_CF_WAIT im nControlFlags-Parameter festgelegt ist, wird ActivateHandler erst zurückgegeben, wenn diese Benachrichtigung vom Synchronisierungscenter verarbeitet wurde.

Beispiele

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

void 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 to activate our handler.
        hr = pControl->ActivateHandler(TRUE, 
                                       s_szMySyncHandlerID, 
                                       hwndOwner,
                                       SYNCMGR_CF_NOWAIT);
        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