PdhGetDefaultPerfCounterHA 函式 (pdh.h)
擷取指定物件的預設計數器名稱。 此名稱可用來在 [瀏覽計數器] 對話框中設定初始計數器選取專案。
此函式與 PdhGetDefaultPerfCounter相同,不同之處在於它支援使用數據源的句柄。
語法
PDH_FUNCTION PdhGetDefaultPerfCounterHA(
[in] PDH_HLOG hDataSource,
[in] LPCSTR szMachineName,
[in] LPCSTR szObjectName,
[out] LPSTR szDefaultCounterName,
[in, out] LPDWORD pcchBufferSize
);
參數
[in] hDataSource
應該 NULL。
如果您指定記錄檔句柄,szDefaultCounterName 將是 null 字串。
[in] szMachineName
Null-terminated 字串,指定用來驗證物件名稱的計算機名稱。 如果 NULL,則會使用本機計算機來驗證名稱。
[in] szObjectName
Null-terminated 字串,指定您想要擷取其預設計數器名稱的物件名稱。
[out] szDefaultCounterName
呼叫端配置的緩衝區,接收 null終止的預設計數器名稱。 如果pcchBufferSize 為零,則設定為 NULL。
[in, out] pcchBufferSize
szDefaultCounterName 緩衝區的大小,TCHAR。 如果輸入為零,函式會傳回PDH_MORE_DATA,並將此參數設定為所需的緩衝區大小。 如果緩衝區大於所需的大小,函式會將此參數設定為使用之緩衝區的實際大小。 如果輸入上的指定大小大於零,但小於所需的大小,則不應該依賴傳回的大小來重新配置緩衝區。
傳回值
如果函式成功,則會傳回ERROR_SUCCESS。
如果函式失敗,傳回值是 系統錯誤碼 或 PDH 錯誤碼。 以下是可能的值。
傳回碼 | 描述 |
---|---|
|
szDefaultCounterName 緩衝區太小,無法包含計數器名稱。 如果輸入時 pcchBufferSize 為零,則應該傳回值。 如果輸入上的指定大小大於零,但小於所需的大小,則不應該依賴傳回的大小來重新配置緩衝區。 |
|
必要的參數無效。 例如,在某些版本中,如果輸入上的指定大小大於零,但小於所需的大小,您可能會收到此錯誤。 |
|
無法配置記憶體以完成函式。 |
|
指定的電腦離線或無法使用。 |
|
無法讀取或找到預設計數器名稱。 |
|
找不到指定的物件。 |
|
物件未指定預設計數器。 |
言論
您應該呼叫此函式兩次,第一次取得所需的緩衝區大小(將 szDefaultCounterName 設為 NULL,pcchBufferSize 為 0),第二次取得數據。
注意
pdh.h 標頭會根據 UNICODE 預處理器常數的定義,將 PdhGetDefaultPerfCounterH 定義為自動選取此函式的 ANSI 或 Unicode 版本。 混合使用編碼中性別名與非編碼中性的程序代碼,可能會導致編譯或運行時間錯誤不符。 如需詳細資訊,請參閱函式原型的
要求
要求 | 價值 |
---|---|
最低支援的用戶端 | Windows XP [僅限傳統型應用程式] |
支援的最低伺服器 | Windows Server 2003 [僅限傳統型應用程式] |
目標平臺 | 窗戶 |
標頭 | pdh.h |
連結庫 | Pdh.lib |
DLL | Pdh.dll |