ISyncMgrHandler::Enable-Methode (syncmgr.h)

  • Artikel

Fordert an, dass ein aktiver Handler aktiviert oder deaktiviert wird. Ein aktivierter Handler kann synchronisiert werden, und ein deaktivierter Handler kann nicht synchronisiert werden.

Syntax

HRESULT Enable(
  [in] BOOL fEnable
);

Parameter

[in] fEnable

Typ: BOOL

TRUE , um zu aktivieren; Zu deaktivierende FALSE .

Rückgabewert

Typ: HRESULT

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

Hinweise

Ein Handler muss die flags SYNCMGR_HCM_CAN_ENABLE und SYNCMGR_HCM_CAN_DISABLE festlegen, damit die Einträge Aktivieren und Deaktivieren im Kontextmenü des Handlers angezeigt werden, wenn der Handler im Ordner Sync Center angezeigt wird. Wenn Sie einen Handler aktivieren, kann er synchronisiert werden. Wenn Sie einen Handler deaktivieren, bedeutet dies, dass dies nicht der Vorgang ist.

Sync Center ruft diese Methode in den folgenden beiden Instanzen auf.

  • Wenn der Benutzer den Handler im Ordner Synchronisierungscenter auswählt und die Aufgabe Aktivieren startet. Wenn der Handler das SYNCMGR_OBJECTID_QueryBeforeEnable-Objekt unterstützt, wird diese Methode nur aufgerufen, wenn der Ui-Vorgang erfolgreich war.
  • Wenn der Benutzer den Handler im Ordner Sync Center auswählt und die Aufgabe Deaktivieren startet. Wenn der Handler das SYNCMGR_OBJECTID_QueryBeforeDisable-Objekt unterstützt, wird diese Methode nur aufgerufen, wenn der Ui-Vorgang erfolgreich war.
Wenn der Handler keine Aktionen ausführen muss, wenn er aktiviert wird, kann er entweder S_OK oder E_NOTIMPL zurückgeben, wie im folgenden Beispiel gezeigt.

Beispiele

Das folgende Beispiel zeigt eine einfache Implementierung dieser Methode.

STDMETHODIMP CMyDeviceHandler::Enable(__in BOOL fEnable)
{
    return E_NOTIMPL;
}

Anforderungen

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

Weitere Informationen

ISyncMgrHandler

ISyncMgrHandler::GetObject

IsEnabled