Функция FilterGetInformation (fltuser.h)

Статья
08/23/2023

Функция FilterGetInformation возвращает различные типы сведений о мини-фильтре.

Синтаксис

HRESULT FilterGetInformation(
  [in]  HFILTER                  hFilter,
  [in]  FILTER_INFORMATION_CLASS dwInformationClass,
  [out] LPVOID                   lpBuffer,
  [in]  DWORD                    dwBufferSize,
  [out] LPDWORD                  lpBytesReturned
);

Параметры

[in] hFilter

Дескриптор, возвращенный предыдущим вызовом функции FilterCreate .

[in] dwInformationClass

Тип запрашиваемой информации. Этот параметр должен иметь одно из следующих значений.

Значение	Значение
FilterFullInformation	Возвращает структуру FILTER_FULL_INFORMATION для мини-фильтра.
FilterAggregateBasicInformation	Возвращает структуру FILTER_AGGREGATE_BASIC_INFORMATION для мини-фильтра. Это значение dwInformationClass доступно начиная с Microsoft Windows Server 2003 с пакетом обновления 1 (SP1) и Microsoft Windows XP с пакетом обновления 2 (SP2) с накопительным пакетом обновления диспетчера фильтров. Дополнительные сведения о накопительном пакете диспетчера фильтров для Windows XP с пакетом обновления 2 (SP2) см. в статье 914882 " Накопительный пакет диспетчера фильтров для Windows XP с пакетом обновления 2 (SP2) в базе знаний Майкрософт.
FilterAggregateStandardInformation	Возвращает структуру FILTER_AGGREGATE_STANDARD_INFORMATION для каждого минифильтра. Часть legacyFilter структуры не используется. Это значение dwInformationClass доступно начиная с Windows Vista.

[out] lpBuffer

Указатель на буфер, выделенный вызывающим объектом, который получает запрошенные сведения. Тип сведений, возвращаемых в буфере, определяется параметром dwInformationClass .

[in] dwBufferSize

Размер (в байтах) буфера, на который указывает параметр lpBuffer . Вызывающий объект должен задать этот параметр в соответствии с заданным dwInformationClass.

[out] lpBytesReturned

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

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

FilterGetInformation возвращает S_OK в случае успешного выполнения. В противном случае возвращается значение ошибки HRESULT, например одно из следующих значений:

Код возврата	Описание
HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER)	Буфер, на который указывает lpBuffer , недостаточно велик, чтобы содержать запрошенные сведения. При возвращении этого значения lpBytesReturned будет содержать размер буфера, необходимого для данной структуры dwInformationClass , в байтах.
HRESULT_FROM_WIN32(ERROR_INVALID_PARAMETER)	Для параметра dwInformationClass указано недопустимое значение. Например, если параметр FilterAggregateStandardInformation указан для операционной системы, предшествующей Windows Vista, функция FilterGetInformation возвращает это значение HRESULT.

Код возврата

Описание

HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER)

Буфер, на который указывает lpBuffer , недостаточно велик, чтобы содержать запрошенные сведения. При возвращении этого значения lpBytesReturned будет содержать размер буфера, необходимого для данной структуры dwInformationClass , в байтах.

HRESULT_FROM_WIN32(ERROR_INVALID_PARAMETER)

Для параметра dwInformationClass указано недопустимое значение. Например, если параметр FilterAggregateStandardInformation указан для операционной системы, предшествующей Windows Vista, функция FilterGetInformation возвращает это значение HRESULT.

Требования


Целевая платформа	Универсальное
Верхняя часть	fltuser.h (включая FltUser.h)
Библиотека	FltLib.lib
DLL	FltLib.dll