структура PDH_BROWSE_DLG_CONFIG_HA (pdh.h)

Статья
11/20/2024

Структура PDH_BROWSE_DLG_CONFIG_H используется функцией PdhBrowseCountersH для настройки счетчиков производительности.

Синтаксис

typedef struct _BrowseDlgConfig_HA {
  DWORD               bIncludeInstanceIndex : 1;
  DWORD               bSingleCounterPerAdd : 1;
  DWORD               bSingleCounterPerDialog : 1;
  DWORD               bLocalCountersOnly : 1;
  DWORD               bWildCardInstances : 1;
  DWORD               bHideDetailBox : 1;
  DWORD               bInitializePath : 1;
  DWORD               bDisableMachineSelection : 1;
  DWORD               bIncludeCostlyObjects : 1;
  DWORD               bShowObjectBrowser : 1;
  DWORD               bReserved : 22;
  HWND                hWndOwner;
  PDH_HLOG            hDataSource;
  LPSTR               szReturnPathBuffer;
  DWORD               cchReturnPathLength;
  CounterPathCallBack pCallBack;
  DWORD_PTR           dwCallBackArg;
  PDH_STATUS          CallBackStatus;
  DWORD               dwDefaultDetailLevel;
  LPSTR               szDialogBoxCaption;
} PDH_BROWSE_DLG_CONFIG_HA, *PPDH_BROWSE_DLG_CONFIG_HA;

Члены

bIncludeInstanceIndex

Если этот флаг TRUE, диалоговое окно содержит номер индекса для повторяющихся имен экземпляров. Например, если есть два экземпляра cmd, список экземпляров будет содержать cmd и cmd#1. Если этот флаг FALSE, повторяющиеся имена экземпляров не будут содержать номер индекса.

bSingleCounterPerAdd

Если этот флаг TRUE, диалоговое окно возвращает только один счетчик. Если этот флаг FALSE, диалоговое окно может возвращать несколько выделений, а подстановочные знаки разрешены. Выбранные счетчики возвращаются в виде строки MULTI_SZ.

bSingleCounterPerDialog

Если этот флаг TRUE, диалоговое окно использует кнопку "ОК" и "Отмена". Диалоговое окно возвращается, когда пользователь нажимает любую кнопку. Если этот флаг FALSE, диалоговое окно использует кнопку "Добавить и закрыть". Диалоговое окно закрывается, когда пользователь нажимает кнопку "Закрыть". Кнопку "Добавить" можно нажать несколько раз. Кнопка "Добавить" перезаписывает ранее выбранные элементы с выбранными в данный момент элементами.

bLocalCountersOnly

Если этот флаг TRUE, диалоговое окно позволяет пользователю выбирать счетчики только с локального компьютера (путь не будет содержать имя компьютера). Если этот флаг FALSE, пользователь может указать компьютер, с которого можно выбрать счетчики. Имя компьютера будет префиксом пути счетчика, если пользователь не выбирает использовать счетчики локальных компьютеров.

bWildCardInstances

Если этот флаг TRUE и пользователь выбирает все экземпляры, путь счетчика будет содержать подстановочный знак для поля экземпляра.

Если этот флаг FALSE, а пользователь выбирает все экземпляры, все экземпляры, найденные в данный момент для этого объекта, будут возвращены в строке MULTI_SZ.

bHideDetailBox

Если этот флаг TRUE, это удаляет уровня сведений из диалогового окна, чтобы пользователь не может изменить уровень детализации счетчиков, отображаемых в диалоговом окне. Уровень детализации будет фиксирован для значения элемента dwDefaultDetailLevel.

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

Обратите внимание, что отображаемые счетчики будут теми, чьи уровни детализации меньше или равно текущему выбору уровня детализации. При выборе уровня детализации мастера будут отображаться все счетчики и объекты.

bInitializePath

Если этот флаг TRUE, диалоговое окно выделяет счетчик и объект, указанные в szReturnPathBuffer при первом отображении диалогового окна, вместо использования счетчика по умолчанию и объекта, указанного компьютером.

Если этот флаг FALSE, он выбирает начальный счетчик и объект с помощью счетчика по умолчанию и сведений об объектах, возвращаемых компьютером.

bDisableMachineSelection

Если этот флаг TRUE, пользователь не может выбрать компьютер из Выбор счетчиков с компьютера.

Если этот флаг FALSE, пользователь может выбрать компьютер из Выбрать счетчики с компьютера. Это значение по умолчанию. Список содержит локальный компьютер, только если вы не вызовете PdhConnectMachine для подключения к другим компьютерам.

bIncludeCostlyObjects

Если этот флаг TRUE, список счетчиков также будет содержать дорогостоящие данные, то есть данные, требующие относительно большого количества времени процессора или памяти для сбора.

Если этот флаг FALSE, список не будет содержать дорогостоящие счетчики. Это значение по умолчанию.

bShowObjectBrowser

Если этот флаг TRUE, в диалоговом окне перечислены только объекты производительности. Когда пользователь выбирает объект, диалоговое окно возвращает путь счетчика, включающий символы объекта и подстановочные знаки для имени экземпляра и счетчика, если объект является объектом нескольких экземпляров. Например, если выбран объект Process, диалоговое окно возвращает строку \Process(*)*. Если объект является одним объектом экземпляра, путь содержит подстановочный знак только для счетчика. Например, \System*. Затем можно передать путь к PdhExpandWildCardPath, чтобы получить список фактических путей для объекта.

bReserved

hWndOwner

Дескриптор окна для владения диалогом. Если null, владелец является рабочим столом.

hDataSource

Обработка источника данных, возвращаемого функцией PdhBindInputDataSource.

szReturnPathBuffer

Указатель на MULTI_SZ, содержащий выбранные пути счетчика.

Если bInitializePathtrue, этот элемент можно использовать для указания пути счетчика, компоненты которого используются для выделения записей на компьютере, объекте, счетчике и списках экземпляров при первом отображении диалогового окна.

cchReturnPathLength

Размер буфера szReturnPathBuffer в TCHARs. Если функция обратного вызова переназначает новый буфер, она также должна обновить это значение.

pCallBack

Указатель на функцию обратного вызова, которая обрабатывает выбор пользователя. Дополнительные сведения см. в CounterPathCallBack.

dwCallBackArg

Определяемое вызывающим значение, передаваемое функции обратного вызова.

CallBackStatus

При входе в функцию обратного вызова этот элемент содержит состояние буфера пути. При выходе функция обратного вызова задает значение состояния, полученное от обработки.

Если буфер слишком мал, чтобы загрузить текущий выбор, диалоговое окно задает для этого значения значение PDH_MORE_DATA. Если это значение ERROR_SUCCESS, то элемент szReturnPathBuffer содержит допустимый путь счетчика или список путей счетчика.

Если функция обратного вызова переназначает новый буфер, он должен задать этот элемент PDH_RETRY, чтобы диалоговое окно попыталось загрузить буфер с выбранными путями и снова вызвать функцию обратного вызова.

Если произошла другая ошибка, функция обратного вызова должна вернуть соответствующее значение состояния ошибки PDH.

dwDefaultDetailLevel

Уровень детализации по умолчанию для отображения в списке уровня сведений , если bHideDetailBox FALSE. Если bHideDetailBoxTRUE, диалоговое окно использует это значение для фильтрации отображаемых счетчиков производительности и объектов. Можно указать одно из следующих значений:

Уровень детализации	Значение
PERF_DETAIL_NOVICE	Начинающий пользователь может понять данные счетчика.
PERF_DETAIL_ADVANCED	Данные счетчика предоставляются для расширенных пользователей.
PERF_DETAIL_EXPERT	Данные счетчика предоставляются для пользователей экспертов.
PERF_DETAIL_WIZARD	Данные счетчика предоставляются для системных конструкторов.

szDialogBoxCaption

Указатель на строку null-terminated, указывающую необязательный заголовок для отображения в строке заголовка диалогового окна. Если этот элемент NULL, заголовок будет счетчиков производительности.

Замечания

При каждом нажатии кнопки "Добавить" буфер szReturnPathBuff er содержит выбранный счетчик и вызывается функция обратного вызова pCallBack. Функция обратного вызова должна вызывать функцию PdhAddCounter для каждого счетчика в буфере.

Заметка

Заголовок pdh.h определяет PDH_BROWSE_DLG_CONFIG_H как псевдоним, который автоматически выбирает версию ANSI или Юникод этой функции на основе определения константы препроцессора ЮНИКОДа. Сочетание использования псевдонима, нейтрального для кодирования, с кодом, не зависящим от кодирования, может привести к несоответствиям, которые приводят к ошибкам компиляции или среды выполнения. Дополнительные сведения см. в соглашениях о прототипах функций.

Требования

Требование	Ценность
минимальные поддерживаемые клиентские	Windows XP [только классические приложения]
минимальный поддерживаемый сервер	Windows Server 2003 [только классические приложения]
заголовка	pdh.h

См. также

CounterPathCallBack

PdhAddCounter

PdhBindInputDataSource

PdhBrowseCountersH

Поделиться через