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 值可從具有 SP1 的 Microsoft Windows Server 2003 開始提供，而 Microsoft Windows XP 搭配 SP2 搭配篩選管理員匯總。 For more information about the filter manager rollup package for Windows XP with SP2, see article 914882, " The filter manager rollup package for Windows XP SP2," in the Microsoft Knowledge Base.
FilterAggregateStandardInformation	傳回每個迷你篩選的FILTER_AGGREGATE_STANDARD_INFORMATION 結構。未使用結構的 LegacyFilter 部分。這個 dwInformationClass 值可從 Windows Vista 開始取得。

[out] lpBuffer

接收所要求資訊的呼叫端配置緩衝區指標。緩衝區中傳回的資訊類型是由 dwInformationClass 參數所定義。

[in] dwBufferSize

lpBuffer參數所指向緩衝區的大小，以位元組為單位。呼叫端應該根據指定的 dwInformationClass來設定此參數。

[out] lpBytesReturned

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

傳回值

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

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