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

Статья
08/25/2023

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

Чтобы использовать дескрипторы для источников данных, используйте функцию PdhEnumMachinesH .

Синтаксис

PDH_FUNCTION PdhEnumMachinesW(
  [in]      LPCWSTR szDataSource,
  [out]     PZZWSTR mszMachineList,
  [in, out] LPDWORD pcchBufferSize
);

Параметры

[in] szDataSource

Строка, завершающаяся значением NULL, указывающая имя файла журнала. Функция перечисляет имена компьютеров, данные счетчиков которых содержатся в файле журнала. Если значение РАВНО NULL, функция перечисляет список компьютеров, указанных при добавлении счетчиков в запрос в режиме реального времени или при вызове функции PdhConnectMachine .

[out] mszMachineList

Буфер, выделенный вызывающим объектом, для получения списка строк с пустым завершением, содержащих имена компьютеров. Список завершается двумя символами конца null. Установите значение NULL , если pcchBufferLength равно нулю.

[in, out] pcchBufferSize

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

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

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

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

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

Код возврата

Описание

PDH_MORE_DATA

Буфер mszMachineNameList слишком мал, чтобы содержать все данные. Это возвращаемое значение ожидается, если pcchBufferLength равен нулю на входе. Если указанный размер входных данных больше нуля, но меньше требуемого размера, не следует полагаться на возвращаемый размер для перераспределения буфера.

PDH_INVALID_ARGUMENT

Недействительный параметр. Например, в некоторых выпусках эта ошибка может возникнуть, если указанный размер входных данных больше нуля, но меньше требуемого размера.

Эту функцию следует вызывать дважды: первый раз, чтобы получить требуемый размер буфера (задайте для mszMachineNameListзначение NULL , а pcchBufferLength — 0), а второй раз — для получения данных.

Примечание

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

Требования

Требование	Значение
Минимальная версия клиента	Windows XP [только классические приложения]
Минимальная версия сервера	Windows Server 2003 [только классические приложения]
Целевая платформа	Windows
Header	pdh.h
Библиотека	Pdh.lib
DLL	Pdh.dll

См. также раздел

PdhConnectMachine

PdhEnumMachinesH

Share via