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

Статья
11/20/2024

Перечисляет имена наборов журналов в dsN.

Синтаксис

PDH_FUNCTION PdhEnumLogSetNamesW(
  [in]      LPCWSTR szDataSource,
  [out]     PZZWSTR mszDataSetNameList,
  [in, out] LPDWORD pcchBufferLength
);

Параметры

[in] szDataSource

строке null-terminated, указывающей dsN.

[out] mszDataSetNameList

Выделенный вызывающим буфером, который получает список имен наборов журналов null-terminated. Список завершается символом null-terminator. Установите значение NULL, если параметр pcchBufferLength равен нулю.

[in, out] pcchBufferLength

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

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

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

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

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

Возвращаемый код

Описание

PDH_MORE_DATA

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

PDH_INVALID_ARGUMENT

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

Замечания

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

Заметка

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

Требования

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

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