pdhGetFormattedCounterValue 函式 (pdh.h)

  • 發行項

計算指定計數器的可顯示值。

語法

PDH_FUNCTION PdhGetFormattedCounterValue(
  [in]  PDH_HCOUNTER          hCounter,
  [in]  DWORD                 dwFormat,
  [out] LPDWORD               lpdwType,
  [out] PPDH_FMT_COUNTERVALUE pValue
);

參數

[in] hCounter

您要計算可顯示值的計數器句柄。 PdhAddCounter 函式會傳回這個句柄。

[in] dwFormat

決定格式化值的數據類型。 指定下列其中一個值。

值 意義
PDH_FMT_DOUBLE
 以雙精確度浮點數實數傳回數據。
PDH_FMT_LARGE
 以 64 位整數的形式傳回數據。
PDH_FMT_LONG
 以長整數的形式傳回數據。
 

您可以使用位包含 OR 運算子 (|) 結合數據類型與下列其中一個縮放比例。

值 意義
PDH_FMT_NOSCALE
 請勿套用計數器的預設縮放比例。
PDH_FMT_NOCAP100
 例如，計數器值大於100 (，在多處理器電腦上測量處理器負載的計數器值) 將不會重設為100。 默認行為是計數器值上限為100。
PDH_FMT_1000
 將實際值乘以 1,000。

[out] lpdwType

接收計數器類型。 如需計數器類型的清單，請參閱 Windows Server 2003 部署套件的計數器類型一節。 這是選擇性參數。

[out] pValue

接收計數器值的 PDH_FMT_COUNTERVALUE 結構。

傳回值

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

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

傳回碼 Description
PDH_INVALID_ARGUMENT
 參數無效或格式不正確。
PDH_INVALID_DATA
 指定的計數器不包含有效的資料或成功的狀態代碼。
PDH_INVALID_HANDLE
 計數器句柄無效。

備註

計數器的數據在 呼叫 PdhGetFormattedCounterValue 期間鎖定 (受保護的) ，以防止在呼叫期間進行任何變更。 讀取數據 (成功呼叫此函式，) 清除計數器的數據變更旗標。

某些計數器，例如速率計數器，需要兩個計數器值才能計算可顯示的值。 在此情況下，您必須先呼叫 PdhCollectQueryData 兩次，再呼叫 PdhGetFormattedCounterValue。 如需詳細資訊，請參閱 收集效能數據。

如果指定的計數器實例不存在，方法會傳回PDH_INVALID_DATA，並將PDH_FMT_COUNTERVALUE結構的 CStatus 成員設定為 PDH_CSTATUS_NO_INSTANCE。

在 Windows Server 2003 之前： 找不到實例時只需要單一值的計數器，格式呼叫可能會失敗。 請嘗試再次呼叫查詢並格式化呼叫。 如果格式呼叫第二次失敗，則找不到 實例。 或者，您可以呼叫 PdhEnumObjects 函式，並將重新整理選項設定為 TRUE ，以在查詢計數器數據並格式化計數器數據之前重新整理計數器實例。

範例

如需範例，請參閱 流覽性能計數器 或 從記錄檔讀取效能數據。

規格需求

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

另請參閱

PdhCollectQueryData

PdhGetRawCounterValue

PdhSetCounterScaleFactor