ISyncMgrSyncItemInfo::IsEnabled-Methode (syncmgr.h)

Artikel
03/04/2024

Generiert einen Wert, der angibt, ob das Element aktiviert ist.

Syntax

HRESULT IsEnabled();

Rückgabewert

Typ: HRESULT

Gibt S_OK zurück, wenn das Element aktiviert ist. andernfalls S_FALSE.

Wenn das Element den aktuellen Zustand des Synchronisierungscenters beibehalten soll, kann es E_NOTIMPL zurückgeben. Wenn ein anderer Wert zurückgegeben wird, legt das Sync Center den aktivierten Status des Elements auf den letzten bekannten Wert fest und aktiviert oder deaktiviert die zugeordneten Aufgaben entsprechend.

Wenn entweder die SYNCMGR_ICM_QUERY_BEFORE_ENABLE- oder SYNCMGR_ICM_QUERY_BEFORE_DISABLE-Flags in der von GetCapabilities zurückgegebenen Maske festgelegt sind, muss der Handler seinen eigenen aktivierten Zustand verwalten und muss daher entweder S_OK oder S_FALSE zurückgeben. Alle anderen Rückgabewerte werden als Fehler betrachtet.

Hinweise

Wenn ein Element deaktiviert ist, wird es nicht vom Synchronisierungscenter synchronisiert. Außerdem werden viele der möglichen Aktionen, die für ein Element verfügbar sind , z. B. Synchronisierung, auf der Benutzeroberfläche entfernt oder deaktiviert.

Ein Element kann einen Nicht getrennten Zustand implementieren, indem es S_FALSE von IsEnabled zurückgibt und das SYNCMR_IPM_PREVENT_ENABLE-Flag in seiner GetPolicies-Implementierung festlegt. Dadurch wird das Element als deaktiviert angezeigt und verhindert, dass der Benutzer es manuell aktiviert.

Der aktivierte 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 CMyDeviceSyncItem::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

Share via