Метод ISyncMgrControl::EnableItem (syncmgr.h)

Статья
08/26/2023

Включает или отключает элемент синхронизации, управляемый указанным обработчиком.

Синтаксис

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

Дескриптор окна, который может использоваться элементом для отображения любого необходимого пользовательского интерфейса. Это значение может иметь значение NULL.

[in] nControlFlags

Тип: SYNCMGR_CONTROL_FLAGS

Значение из перечисления SYNCMGR_CONTROL_FLAGS , указывающее, следует ли включать или отключать элемент синхронно или асинхронно.

Возвращаемое значение

Тип: HRESULT

Если этот метод завершается успешно, он возвращает S_OK. В противном случае возвращается код ошибки HRESULT .

Если указанный элемент возвращает SYNCMGR_ICM_QUERY_BEFORE_ENABLE или SYNCMGR_ICM_QUERY_BEFORE_DISABLE в маске, возвращенной методом GetCapabilities , пользователь получает диалоговое окно подтверждения, запрошенное до включения или отключения элемента. Если пользовательский интерфейс запроса не запрашивается или пользователь подтверждает операцию, вызывается метод Enable элемента.

Если SYNCMGR_CF_WAIT задано в параметре nControlFlags , 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
Header	syncmgr.h

Share via