ISyncMgrControl：：EnableItem 方法 (syncmgr.h)

啟用或停用由指定處理程式管理的同步處理專案。

語法

HRESULT EnableItem(
  [in] BOOL                  fEnable,
  [in] LPCWSTR               pszHandlerID,
  [in] LPCWSTR               pszItemID,
  [in] HWND                  hwndOwner,
  [in] SYNCMGR_CONTROL_FLAGS nControlFlags
);

參數

[in] fEnable

類型： BOOL

TRUE 表示啟用; 要 停用的 FALSE。

[in] pszHandlerID

類型： LPCWSTR

緩衝區的指標，其中包含處理程式的唯一標識符。 此字串的長度上限MAX_SYNCMGR_ID包括終止 的 Null 字元。

[in] pszItemID

類型： LPCWSTR

緩衝區的指標，其中包含專案的唯一標識符。 此字串的長度上限MAX_SYNCMGR_ID包括終止 的 Null 字元。

[in] hwndOwner

類型： HWND

項目可用來顯示任何必要UI之視窗的句柄。 此值可以是 NULL。

[in] nControlFlags

類型： SYNCMGR_CONTROL_FLAGS

來自 SYNCMGR_CONTROL_FLAGS 列舉的值，指定專案啟用或停用是否應該以同步或異步方式執行。

傳回值

類型： HRESULT

如果此方法成功，則會傳回 S_OK。 否則，它會傳回 HRESULT 錯誤碼。

備註

已啟用的專案是可以同步處理的專案。

如果指定的專案在 GetCapabilities 方法傳回的遮罩中傳回SYNCMGR_ICM_QUERY_BEFORE_ENABLE或SYNCMGR_ICM_QUERY_BEFORE_DISABLE，則會在啟用或停用專案之前，向使用者顯示確認對話方塊。 如果未要求查詢 UI，或使用者確認作業之後，就會呼叫專案的 Enable 方法。

如果已在 nControlFlags 參數中設定SYNCMGR_CF_WAIT，則在同步中心處理此通知之前， EnableItem 不會傳回。

範例

下列範例顯示處理程式程式的 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 disable the item.
        hr = pControl->EnableItem(FALSE, 
                                  s_szMySyncHandlerID,
                                  s_szMySyncHandlerMusicContentID, 
                                  hwnd,
                                  SYNCMGR_CF_WAIT);
        pControl->Release();
    }

    ...

}

規格需求

需求	值
最低支援的用戶端	Windows Vista [僅限傳統型應用程式]
最低支援的伺服器	Windows Server 2008 [僅限傳統型應用程式]
目標平台	Windows
標頭	syncmgr.h