FilterInstanceGetInformation 函式 (fltuser.h)

發行項
02/29/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

呼叫端配置的變數指標，該變數會接收 lpBuffer 指向之緩衝區中傳回的位元組數目，如果 FilterInstanceGetInformation 的 呼叫成功。這個參數是必要的，而且不能是 NULL。

傳回值

如果成功，FilterInstanceGetInformation 會傳回S_OK。否則，它會傳回 HRESULT 錯誤值，例如下列其中一項：

傳回碼	Description
HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER)	lpBuffer 指向的緩衝區不夠大，無法包含要求的資訊。傳回此值時， lpBytesReturned 會包含指定 dwInformationClass 結構所需的緩衝區大小，以位元組為單位。
HRESULT_FROM_WIN32 (ERROR_INVALID_PARAMETER)	為 dwInformationClass 參數指定了無效的值。例如，如果在 Windows Vista 之前為作業系統指定 InstanceAggregateStandardInformation，FilterInstanceGetInformation 會傳回這個 HRESULT 值。