ISyncMgrHandlerInfo::IsEnabled-Methode (syncmgr.h)

  • Artikel

Ruft einen Wert ab, der angibt, ob der Handler aktiviert ist.

Syntax

HRESULT IsEnabled();

Rückgabewert

Typ: HRESULT

Gibt S_OK zurück, wenn der Handler aktiviert ist. andernfalls S_FALSE.

Wenn der Handler möchte, dass das Synchronisierungscenter den aktuellen Zustand behält, kann er E_NOTIMPL zurückgeben. Wenn ein anderer Wert zurückgegeben wird, legt das Synchronisierungscenter den aktivierten Zustand des Handlers auf den letzten bekannten Wert fest und aktiviert oder deaktiviert die zugeordneten Aufgaben nach Bedarf.

Wenn entweder das SYNCMGR_HCM_QUERY_BEFORE_ENABLE- oder SYNCMGR_HCM_QUERY_BEFORE_DISABLE-Flag in der von GetCapabilities zurückgegebenen Maske festgelegt ist, muss der Handler seinen eigenen aktivierten Zustand verwalten und daher entweder S_OK oder S_FALSE zurückgeben. Jeder andere Rückgabewert wird als Fehler betrachtet.

Hinweise

Wenn ein Handler deaktiviert ist, wird weder er noch eines seiner Elemente vom Synchronisierungscenter synchronisiert. Außerdem werden viele der möglichen Aktionen, die für einen Handler verfügbar sind, z. B. Synchronisierung, auf der Benutzeroberfläche des Synchronisierungscenterordners entfernt oder deaktiviert.

Dieser Wert ist in der Ordnerbenutzeroberfläche als System.Sync.Enabled-Eigenschaft (PKEY_Sync_Enabled) verfügbar.

Sync Center ruft diese Methode immer dann auf, wenn die UpdateHandler-Methode aufgerufen wird.

Beispiele

Das folgende Beispiel zeigt eine Implementierung dieser Methode, die eine private Klassenfunktion aufruft, um den aktivierten Zustand abzurufen.

STDMETHODIMP CMyDeviceHandler::IsEnabled()
{
    // Return a previously-calculated value.
    return (_fIsEnabled ? S_OK : S_FALSE);
}

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

Weitere Informationen

Aktivieren

ISyncMgrHandlerInfo