PdhLookupPerfNameByIndexW 函式 (pdh.h)
傳回對應至指定索引的效能物件名稱或計數器名稱。
語法
PDH_FUNCTION PdhLookupPerfNameByIndexW(
[in] LPCWSTR szMachineName,
[in] DWORD dwNameIndex,
[out] LPWSTR szNameBuffer,
[in, out] LPDWORD pcchNameBufferSize
);
參數
[in] szMachineName
Null 終止的字串,指定指定指定性能物件或計數器所在計算機的名稱。 計算機名稱可由 DNS 名稱或 IP 位址指定。 如果 為 NULL,函式會使用本機電腦。
[in] dwNameIndex
性能物件或計數器的索引。
[out] szNameBuffer
呼叫端配置的緩衝區,接收性能物件或計數器的 Null 終止名稱。 如果pcchNameBufferSize為零,請將 設定為NULL。
[in, out] pcchNameBufferSize
SzNameBuffer 緩衝區的大小,以 TCHAR 為單位。 如果輸入為零,則函式會傳回PDH_MORE_DATA,並將此參數設定為必要的緩衝區大小。 如果緩衝區大於所需的大小,函式會將此參數設定為所使用之緩衝區的實際大小。 如果輸入上的指定大小大於零,但小於所需的大小,您就不應該依賴傳回的大小來重新配置緩衝區。
傳回值
如果函式成功,它會傳回ERROR_SUCCESS。
如果函式失敗,傳回值為 系統錯誤碼 或 PDH 錯誤碼。 以下是可能的值。
傳回碼 | Description |
---|---|
|
szNameBuffer 緩衝區不夠大,無法包含計數器名稱。 如果 輸入上的pcchNameBufferSize 為零,就會預期此傳回值。 如果輸入上的指定大小大於零,但小於所需的大小,您就不應該依賴傳回的大小來重新配置緩衝區。 |
|
參數無效或格式不正確。 例如,在某些版本中,如果輸入上的指定大小大於零,但小於所需的大小,您可能會收到此錯誤。 |
備註
您應該第一次呼叫此函式兩次,以取得所需的緩衝區大小, (將 szNameBuffer 設定為 NULL , 並將 pcchNameBufferSize 設定為 0) ,第二次取得數據。
Windowsxp: 您必須指定緩衝區和緩衝區大小。 函式會將 pcchNameBufferSize 設定為所需的大小或所使用的緩衝區大小。 如果緩衝區太小,函式會傳回PDH_INSUFFICIENT_BUFFER,而不是PDH_MORE_DATA。 以位元組為單位的字串大小上限是PDH_MAX_COUNTER_NAME * sizeof (TCHAR) 。
您指定的索引值必須符合其中一個與電腦上載入的物件或計數器相關聯的索引值。 索引/名稱值組會儲存在下列登錄位置的 Counters 登錄值中。
HKEY_LOCAL_MACHINE \SOFTWARE \Microsoft \Windows NT \CurrentVersion \Perflib Last Counter = highest counter index Last Help = highest help index \009 Counters = 2 System 4 Memory... Help = 3 The System Object Type... \supported language, other than English Counters = ... Help = ...
注意
pdh.h 標頭會根據 UNICODE 預處理器常數的定義,將 PdhLookupPerfNameByIndex 定義為自動選取此函式的 ANSI 或 Unicode 版本。 混合使用編碼中性別名與非編碼中性的程序代碼,可能會導致編譯或運行時間錯誤不符。 如需詳細資訊,請參閱 函式原型的慣例。
規格需求
需求 | 值 |
---|---|
最低支援的用戶端 | Windows XP [僅限傳統型應用程式] |
最低支援的伺服器 | Windows Server 2003 [僅限傳統型應用程式] |
目標平台 | Windows |
標頭 | pdh.h |
程式庫 | Pdh.lib |
Dll | Pdh.dll |