(syncmgr.h) ISyncMgrHandlerInfo::IsEnabled 方法
取得值,這個值表示是否啟用處理程式。
Syntax
HRESULT IsEnabled();
傳回值
類型: HRESULT
如果已啟用處理程式,則傳回S_OK;否則為 S_FALSE。
如果處理程式想要同步處理中心維持目前狀態,它可以傳回E_NOTIMPL。 如果傳回任何其他值,同步中心會將處理程式的已啟用狀態設定為最後一個已知值,並適當地啟用或停用相關聯的工作。
如果SYNCMGR_HCM_QUERY_BEFORE_ENABLE或SYNCMGR_HCM_QUERY_BEFORE_DISABLE旗標是在 GetCapabilities 傳回的遮罩中設定,處理程式必須管理自己的啟用狀態,因此必須傳回S_OK或S_FALSE。 任何其他傳回值都會被視為錯誤。
備註
如果處理程式已停用,則同步中心不會同步處理處理程式及其任何專案。 此外,許多可用於處理程式的可能動作,例如 Sync,都會在同步中心資料夾 UI 中移除或停用。
這個值可在資料夾 UI 中當做 System.Sync.Enabled (PKEY_Sync_Enabled) 屬性使用。
每當呼叫 UpdateHandler 方法時,同步中心就會呼叫此方法。
範例
下列範例示範這個方法的實作,這個方法會呼叫私用類別函式來擷取啟用的狀態。
STDMETHODIMP CMyDeviceHandler::IsEnabled()
{
// Return a previously-calculated value.
return (_fIsEnabled ? S_OK : S_FALSE);
}
規格需求
需求 | 值 |
---|---|
最低支援的用戶端 | Windows Vista [僅限傳統型應用程式] |
最低支援的伺服器 | Windows Server 2008 [僅限傳統型應用程式] |
目標平台 | Windows |
標頭 | syncmgr.h |