ISyncMgrHandler::Activate-Methode (syncmgr.h)

  • Artikel

Fordert an, dass der Handler aktiviert oder deaktiviert ist. Ein aktiver Handler kann synchronisiert werden. ein inaktiver Handler kann dies nicht.

Syntax

HRESULT Activate(
  [in] BOOL fActivate
);

Parameter

[in] fActivate

Typ: BOOL

TRUE , um zu aktivieren; False , um zu deaktivieren.

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 und kann synchronisiert werden. Ein inaktiver Handler wird im Ordner Synchronisierungseinrichtung angezeigt und muss aktiviert werden (wodurch er in den Ordner Sync Center verschoben wird), bevor er synchronisiert werden kann.

Der Aktivierungsstatus sollte nicht mit dem aktivierten Zustand verwechselt werden. Ein aktiver Handler kann deaktiviert werden. Dies bedeutet, dass es weiterhin im Ordner Sync Center angezeigt wird, aber nicht synchronisiert werden kann.

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

  • Wenn der Benutzer den Handler im Ordner Synchronisierungseinrichtung auswählt und seine Setupaufgabe startet. Wenn der Handler das SYNCMGR_OBJECTID_QueryBeforeActivate -Objekt unterstützt, wird diese Methode nur aufgerufen, wenn der Ui-Vorgang, der aus einem Dialogfeld besteht, in dem der Benutzer aufgefordert wird, zu bestätigen, ob er den Handler aktivieren möchte, erfolgreich war.
  • Wenn der Benutzer den Handler im Ordner Sync Center auswählt und die Aufgabe Löschen startet, jedoch nur, wenn der Handler das SYNCMGR_HPM_PREVENT_DEACTIVATE-Flag nicht festgelegt hat. Wenn der Handler das SYNCMGR_OBJECTID_QueryBeforeDeactivate-Objekt unterstützt, wird diese Methode nur aufgerufen, wenn der Ui-Vorgang erfolgreich war.
Wenn das SYNCMGR_HPM_PREVENT_ACTIVATE-Flag in dem von ISyncMgrHandler::GetCapabilities abgerufenen Wert festgelegt ist, schlägt ein Aufruf dieser Methode, die die Aktivierung des Handlers anfordert, fehl.

Der Aktivierungsstatus eines einzelnen Handlers kann durch Aufrufen von IsActive ermittelt werden.

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::Activate(__in BOOL fActivate)
{
    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

ISyncMgrUIOperation::Ausführen