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

Статья
08/23/2023

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

Синтаксис

HRESULT FilterInstanceGetInformation(
  [in]  HFILTER_INSTANCE           hInstance,
  [in]  INSTANCE_INFORMATION_CLASS dwInformationClass,
  [out] LPVOID                     lpBuffer,
  [in]  DWORD                      dwBufferSize,
  [out] LPDWORD                    lpBytesReturned
);

Параметры

[in] hInstance

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

[in] dwInformationClass

Тип возвращаемой структуры сведений об экземпляре. Этот параметр должен содержать одно из следующих значений.

Значение	Значение
InstanceBasicInformation	Возвращает структуру INSTANCE_BASIC_INFORMATION для экземпляра .
InstanceFullInformation	Возвращает структуру INSTANCE_FULL_INFORMATION для экземпляра .
InstancePartialInformation	Возвращает структуру INSTANCE_PARTIAL_INFORMATION для экземпляра .
InstanceAggregateStandardInformation	Возвращает структуру INSTANCE_AGGREGATE_STANDARD_INFORMATION для экземпляра . Часть структуры LegacyFilter используется начиная с Windows 8. Эта структура доступна начиная с Windows Vista.

[out] lpBuffer

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

[in] dwBufferSize

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

[out] lpBytesReturned

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

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

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

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

Код возврата

Описание

HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER)

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

HRESULT_FROM_WIN32(ERROR_INVALID_PARAMETER)

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

При использовании дескриптора для экземпляра минифильтра эта подпрограмма возвращает сведения об экземпляре минифильтра. Тип возвращаемых сведений об экземпляре определяется параметром dwInformationClass .

FilterInstanceGetInformation — это эквивалент Win32 FltGetInstanceInformation.

Требования

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