ISyncMgrHandlerInfo::IsActive-Methode (syncmgr.h)
Ruft einen Wert ab, der angibt, ob der Handler synchronisiert werden kann.
Syntax
HRESULT IsActive();
Rückgabewert
Typ: HRESULT
Gibt S_OK zurück, wenn der Handler aktiv 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 Zustand des Handlers auf den letzten bekannten Wert fest. Wenn der letzte bekannte Wert des Handlers in dieser Situation inaktiv war, deaktiviert das Synchronisierungscenter den Setuptask . Wenn der letzte bekannte Wert des Handlers aktiv war, ist die Aufgabe Löschen nicht deaktiviert.
Wenn entweder das SYNCMGR_HCM_QUERY_BEFORE_ACTIVATE- oder SYNCMGR_HCM_QUERY_BEFORE_DEACTIVE-Flag in der von GetCapabilities zurückgegebenen Maske festgelegt ist, muss der Handler seinen eigenen Aktivierungsstatus verwalten und daher entweder S_OK oder S_FALSE zurückgeben. Jeder andere Rückgabewert wird als Fehler betrachtet.
Hinweise
Wenn ein Handler nicht aktiv ist, wird er im Ordner Synchronisierungssetup angezeigt. Handler in diesem Ordner können nicht synchronisiert werden. Um einen Handler in den Ordner "Synchronisierungscenter" zu verschieben, wählt der Benutzer die Setupaufgabe im Kontextmenü des Handlers oder im Befehlsmodul aus.
Wenn ein Handler aktiv ist, wird er im Ordner Standard Synchronisierungscenter angezeigt. Ein aktiver Handler kann entweder vom Benutzer oder über die ISyncMgrControl-Schnittstelle synchronisiert werden. Um einen Handler in den Ordner Sync Setup zu verschieben, wählt der Benutzer im Kontextmenü des Handlers oder im Befehlsmodul die Aufgabe Löschen aus.
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 aktiven Zustand abzurufen.
STDMETHODIMP CMyDeviceHandler::IsActive()
{
// Return a previously-calculated value.
return (_fIsActive ? 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 |