PdhGetCounterInfoA 函式 (pdh.h)

  • 發行項

擷取計數器的相關信息，例如數據大小、計數器類型、路徑和使用者提供的數據值。

語法

PDH_FUNCTION PdhGetCounterInfoA(
  [in]      PDH_HCOUNTER        hCounter,
  [in]      BOOLEAN             bRetrieveExplainText,
  [in, out] LPDWORD             pdwBufferSize,
  [out]     PPDH_COUNTER_INFO_A lpBuffer
);

參數

[in] hCounter

要從中擷取資訊的計數器句柄。 PdhAddCounter 函式會傳回這個句柄。

[in] bRetrieveExplainText

判斷是否擷取說明文字。 如果您將此參數設定為 TRUE，則會擷取計數器的說明文字。 如果您將此參數設定為 FALSE，則傳回緩衝區中的欄位為 NULL。

[in, out] pdwBufferSize

lpBuffer 緩衝區的大小，以位元組為單位。 如果輸入為零，函式會傳回PDH_MORE_DATA，並將此參數設定為所需的緩衝區大小。 如果緩衝區大於所需的大小，函式會將此參數設定為所使用緩衝區的實際大小。 如果輸入上的指定大小大於零，但小於所需的大小，您就不應該依賴傳回的大小來重新配置緩衝區。

[out] lpBuffer

接收 PDH_COUNTER_INFO 結構的呼叫端配置緩衝區。 結構是可變長度的，因為字串數據會附加至結構的固定格式部分結尾。 如此一來，呼叫端所配置的單一緩衝區就會傳回所有數據。 如果 pdwBufferSize 為零，則設定為 NULL。

傳回值

如果函式成功，則會傳回ERROR_SUCCESS。

如果函式失敗，傳回值為 系統錯誤碼 或 PDH 錯誤碼。 以下是可能的值。

傳回碼 Description
PDH_INVALID_ARGUMENT
 參數無效或格式不正確。 例如，在某些版本中，如果輸入上的指定大小大於零，但小於所需的大小，您可能會收到此錯誤。
PDH_INVALID_HANDLE
 計數器句柄無效。
PDH_MORE_DATA
 lpBuffer 緩衝區太小，無法保存計數器資訊。 如果 pdwBufferSize 在輸入時為零，則預期會傳回值。 如果輸入上的指定大小大於零，但小於所需的大小，您就不應該依賴傳回的大小來重新配置緩衝區。

備註

您應該呼叫此函式兩次，第一次取得所需的緩衝區大小， (將 lpBuffer 設定為 NULL ，並將 pdwBufferSize 設定為 0) ，第二次取得數據。

注意

pdh.h 標頭會將 PdhGetCounterInfo 定義為別名，根據 UNICODE 預處理器常數的定義，自動選取此函式的 ANSI 或 Unicode 版本。 混合使用編碼中性別名與非編碼中性的程序代碼，可能會導致編譯或運行時間錯誤不符。 如需詳細資訊，請參閱 函式原型的慣例。

規格需求

需求 值
最低支援的用戶端 Windows XP [僅限傳統型應用程式]
最低支援的伺服器 Windows Server 2003 [僅限桌面應用程式]
目標平台 Windows
標頭 pdh.h
程式庫 Pdh.lib
Dll Pdh.dll

另請參閱

PDH_COUNTER_INFO