ISyncMgrControl::EnableHandler-Methode (syncmgr.h)

Artikel
03/02/2024

Aktiviert oder deaktiviert einen Handler.

Syntax

HRESULT EnableHandler(
  [in] BOOL                  fEnable,
  [in] LPCWSTR               pszHandlerID,
  [in] HWND                  hwndOwner,
  [in] SYNCMGR_CONTROL_FLAGS nControlFlags
);

Parameter

[in] fEnable

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 beendenden 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 das Aktivieren oder Deaktivieren 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

Ein aktiver Handler wird im Ordner Sync Center angezeigt. ein inaktiver Handler wird im Ordner Synchronisierungseinrichtung angezeigt.

Wenn der angegebene Handler SYNCMGR_HCM_QUERY_BEFORE_ENABLE oder SYNCMGR_HCM_QUERY_BEFORE_DISABLE in der von der GetCapabilities-Methode zurückgegebenen Maske zurückgibt, wird dem Benutzer ein Bestätigungsdialogfeld angezeigt, das angefordert wird, bevor der Handler aktiviert oder deaktiviert wird. Wenn keine Abfrage-UI angefordert wird oder der Benutzer den Vorgang bestätigt, wird die Enable-Methode des Handlers aufgerufen.

Wenn SYNCMGR_CF_WAIT im Parameter nControlFlags festgelegt ist, wird EnableHandler erst zurückgegeben, wenn das Sync Center diese Benachrichtigung verarbeitet hat.

Beispiele

Das folgende Beispiel zeigt die Verwendung von ISyncMgrControl::EnableHandler 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 enable our handler.
        hr = pControl->EnableHandler(TRUE, 
                                     s_szMySyncHandlerID, 
                                     hwnd,
                                     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

Share via