ISyncMgrControl::EnableHandler 方法 (syncmgr.h)
啟用或停用處理程式。
語法
HRESULT EnableHandler(
[in] BOOL fEnable,
[in] LPCWSTR pszHandlerID,
[in] HWND hwndOwner,
[in] SYNCMGR_CONTROL_FLAGS nControlFlags
);
參數
[in] fEnable
類型: BOOL
TRUE 表示啟用; 要停用的 FALSE 。
[in] pszHandlerID
類型: LPCWSTR
緩衝區的指標,其中包含處理程式的唯一標識符。 此字串長度上限MAX_SYNCMGR_ID包括終止 Null 字元。
[in] hwndOwner
類型: HWND
處理程式可用來顯示任何必要UI之視窗的句柄。 此值可以是 NULL。
[in] nControlFlags
來自 SYNCMGR_CONTROL_FLAGS列舉的值 ,指定是否應該以同步或異步方式執行處理程式的啟用或停用。
傳回值
類型: HRESULT
如果此方法成功,則會傳回 S_OK。 否則,它會傳回 HRESULT 錯誤碼。
備註
作用中的處理程式會出現在 [同步中心] 資料夾中;非作用中的處理程式會出現在 [同步設定] 資料夾中。
如果指定的處理程式在 GetCapabilities 方法傳回的遮罩中傳回SYNCMGR_HCM_QUERY_BEFORE_ENABLE或SYNCMGR_HCM_QUERY_BEFORE_DISABLE,則會在啟用或停用處理程式之前,向使用者顯示確認對話方塊。 如果未要求任何查詢 UI,或使用者確認作業之後,就會呼叫處理程式的 Enable 方法。
如果在 nControlFlags 參數中設定SYNCMGR_CF_WAIT, 則 EnableHandler 不會在同步中心處理此通知之前傳回。
範例
下列範例顯示處理程式的程式使用 ISyncMgrControl::EnableHandler 。
void MiscProc(...)
{
...
// Get the Sync Center control object.
ISyncMgrControl *pControl = NULL;
hr = CoCreateInstance(CLSID_SyncMgrControl,
CLSCTX_SERVER,
IID_PPV_ARGS(&pControl));
if (SUCCEEDED(hr))
{
// Tell Sync Center to enable our handler.
hr = pControl->EnableHandler(TRUE,
s_szMySyncHandlerID,
hwnd,
SYNCMGR_CF_NOWAIT);
pControl->Release();
}
...
}
規格需求
需求 | 值 |
---|---|
最低支援的用戶端 | Windows Vista [僅限傳統型應用程式] |
最低支援的伺服器 | Windows Server 2008 [僅限傳統型應用程式] |
目標平台 | Windows |
標頭 | syncmgr.h |