FilterInstanceGetInformation 函数 (fltuser.h)

项目
02/26/2024

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

指向调用方分配的变量的指针，如果对 FilterInstanceGetInformation 的调用成功，该变量接收 lpBuffer 指向的缓冲区中返回的字节数。此参数是必需的，不能为 NULL。

返回值

如果成功，FilterInstanceGetInformation 将返回S_OK。否则，它将返回 HRESULT 错误值，如以下值之一：

返回代码	说明
HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER)	lpBuffer 指向的缓冲区不够大，无法包含请求的信息。返回此值时， lpBytesReturned 将包含给定 dwInformationClass 结构所需的缓冲区大小（以字节为单位）。
HRESULT_FROM_WIN32 (ERROR_INVALID_PARAMETER)	为 dwInformationClass 参数指定了无效值。例如，如果为 Windows Vista 之前的操作系统指定了 InstanceAggregateStandardInformation ，则 FilterInstanceGetInformation 将返回此 HRESULT 值。