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

Статья
11/20/2024

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

Синтаксис

PDH_FUNCTION PdhGetRawCounterArrayA(
  [in]      PDH_HCOUNTER            hCounter,
  [in, out] LPDWORD                 lpdwBufferSize,
  [out]     LPDWORD                 lpdwItemCount,
  [out]     PPDH_RAW_COUNTER_ITEM_A ItemBuffer
);

Параметры

[in] hCounter

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

[in, out] lpdwBufferSize

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

[out] lpdwItemCount

Количество необработанных значений счетчиков в буфере ItemBuffer.

[out] ItemBuffer

Выделенный вызывающим буфером, который получает массив PDH_RAW_COUNTER_ITEM структур; Структуры содержат значения счетчика необработанных экземпляров. Установите значение NULL, если lpdwBufferSize равно нулю.

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

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

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

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

Замечания

Эта функция должна вызываться дважды, при первом получении требуемого размера буфера (присвойте ItemBuffer значение NULL и lpdwBufferSize значение 0), а также во второй раз, чтобы получить данные.

Данные счетчика блокировались на время вызова PdhGetRawCounterArray, чтобы предотвратить любые изменения во время обработки вызова.

Заметка

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

Требования

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

См. также

PDH_RAW_COUNTER_ITEM

PdhCalculateCounterFromRawValue

PdhGetFormattedCounterArray

PdhGetFormattedCounterValue

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