Функция PdhGetCounterInfoA (pdh.h)

Статья
11/20/2024

Извлекает сведения о счетчике, таких как размер данных, тип счетчика, путь и значения данных, предоставленные пользователем.

Синтаксис

PDH_FUNCTION PdhGetCounterInfoA(
  [in]      PDH_HCOUNTER        hCounter,
  [in]      BOOLEAN             bRetrieveExplainText,
  [in, out] LPDWORD             pdwBufferSize,
  [out]     PPDH_COUNTER_INFO_A lpBuffer
);

Параметры

[in] hCounter

Дескриптор счетчика, из которого требуется получить информацию. Функция PdhAddCounter возвращает этот дескриптор.

[in] bRetrieveExplainText

Определяет, извлекается ли текст объяснения. Если задать для этого параметра значение TRUE, извлекается текст объяснения счетчика. Если для этого параметра задано значение false false, поле в возвращаемом буфере NULL.

[in, out] pdwBufferSize

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

[out] lpBuffer

Выделенный вызывающим буфером, который получает PDH_COUNTER_INFO структуру. Структура имеет переменную длину, так как строковые данные добавляются в конец части структуры фиксированного формата. Это делается так, чтобы все данные возвращались в одном буфере, выделенном вызывающим объектом. Установите значение NULL, если pdwBufferSize равно нулю.

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

Если функция выполнена успешно, она возвращает ERROR_SUCCESS.

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

Возвращаемый код	Описание
PDH_INVALID_ARGUMENT	Недопустимый параметр или неправильно отформатирован. Например, в некоторых выпусках можно получить эту ошибку, если указанный размер входных данных больше нуля, но меньше требуемого размера.
PDH_INVALID_HANDLE	Недопустимый дескриптор счетчика.
PDH_MORE_DATA	Буфер lpBuffer слишком мал для хранения сведений счетчика. Это возвращаемое значение ожидается, если pdwBufferSize равно нулю входных данных. Если указанный размер входных данных больше нуля, но меньше требуемого размера, не следует полагаться на возвращаемый размер, чтобы перераспределить буфер.

Замечания

Эту функцию следует вызывать дважды, при первом получении требуемого размера буфера (присвойте lpBuffer значение null и pdwBufferSize значение 0), а второй раз— получить данные.

Заметка

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

Требования

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

См. также

PDH_COUNTER_INFO

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