PdhMakeCounterPathA 函式 (pdh.h)

  • 發行項

使用 PDH_COUNTER_PATH_ELEMENTS 結構中指定的成員，建立完整的計數器路徑。

語法

PDH_FUNCTION PdhMakeCounterPathA(
  [in]      PPDH_COUNTER_PATH_ELEMENTS_A pCounterPathElements,
  [out]     LPSTR                        szFullPathBuffer,
  [in, out] LPDWORD                      pcchBufferSize,
  [in]      DWORD                        dwFlags
);

參數

[in] pCounterPathElements

PDH_COUNTER_PATH_ELEMENTS 結構，其中包含用來組成路徑的成員。 只有 szObjectName 和 szCounterName 成員是必要的，其他成員則是選擇性的。

如果實例名稱成員為 NULL，路徑將不會包含實例參考，而且將會忽略 szParentInstance 和 dwInstanceIndex 成員。

[out] szFullPathBuffer

呼叫端配置的緩衝區，接收 以 Null 終止的計數器路徑。 計數器路徑的最大長度是PDH_MAX_COUNTER_PATH。 如果pcchBufferSize為零，請將 設定為NULL。

[in, out] pcchBufferSize

TCHAR 中 szFullPathBuffer 緩衝區的大小。 如果輸入為零，則函式會傳回PDH_MORE_DATA，並將此參數設定為必要的緩衝區大小。 如果緩衝區大於所需的大小，函式會將此參數設定為所使用之緩衝區的實際大小。 如果輸入上的指定大小大於零，但小於所需的大小，您就不應該依賴傳回的大小來重新配置緩衝區。

[in] dwFlags

輸入和輸出計數器值的格式。 您可以指定下列其中一個值。

值 意義
PDH_PATH_WBEM_RESULT
 將 PDH 路徑轉換為 WMI 類別和屬性名稱格式。
PDH_PATH_WBEM_INPUT
 將 WMI 類別和屬性名稱轉換為 PDH 路徑。
0
 傳回 PDH 格式的路徑，例如 \\computer\object (parent/instance#index) \counter。

傳回值

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

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

傳回碼 Description
PDH_MORE_DATA
 szFullPathBuffer 緩衝區太小而無法包含計數器名稱。 如果 輸入上的pcchBufferSize 為零，就會預期此傳回值。 如果輸入上的指定大小大於零，但小於所需的大小，您就不應該依賴傳回的大小來重新配置緩衝區。
PDH_INVALID_ARGUMENT
 參數無效或格式不正確。 例如，在某些版本中，如果輸入上的指定大小大於零，但小於所需的大小，您可能會收到此錯誤。

備註

您應該第一次呼叫此函式兩次，以取得必要的緩衝區大小， (將 szFullPathBuffer 設定為 NULL ， 並將 pcchBufferSize 設定為 0) ，第二次取得數據。

注意

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

規格需求

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

另請參閱

PDH_COUNTER_PATH_ELEMENTS

PdhParseCounterPath