PdhEnumObjectsHA 函式 (pdh.h)
傳回指定電腦上或指定記錄檔中可用的物件清單。
此函式與 PdhEnumObjects相同,不同之處在於它支援使用數據源的句柄。
語法
PDH_FUNCTION PdhEnumObjectsHA(
[in] PDH_HLOG hDataSource,
[in] LPCSTR szMachineName,
[out] PZZSTR mszObjectList,
[in, out] LPDWORD pcchBufferSize,
[in] DWORD dwDetailLevel,
[in] BOOL bRefresh
);
參數
[in] hDataSource
PdhBindInputDataSource 函式所傳回數據源的句柄。
[in] szMachineName
Null-terminated 字串串,指定用來列舉性能對象的計算機名稱。
在計算機名稱中包含前置斜線,例如 \computername。
如果
[out] mszObjectList
接收物件名稱清單的呼叫端配置緩衝區。 此清單中的每個物件名稱都會以 null 字元
[in, out] pcchBufferSize
TCHAR中,mszObjectList 緩衝區的大小。 如果輸入為零,函式會傳回PDH_MORE_DATA,並將此參數設定為所需的緩衝區大小。 如果緩衝區大於所需的大小,函式會將此參數設定為使用之緩衝區的實際大小。 如果輸入上的指定大小大於零,但小於所需的大小,則不應該依賴傳回的大小來重新配置緩衝區。
Windows XP:將一個新增至所需的緩衝區大小。
[in] dwDetailLevel
要傳回之效能項目的詳細數據層級。 會傳回屬於指定詳細層級或更少專案的所有專案(層級會以遞增順序列出)。 此參數可以是下列其中一個值。
價值 | 意義 |
---|---|
|
新手使用者詳細數據層級。 |
|
進階使用者詳細數據層級。 |
|
專家用戶層級的詳細數據。 |
|
系統設計工具的詳細數據層級。 |
[in] bRefresh
指出是否應該自動重新整理快取的物件清單。 指定下列其中一個值。
如果您呼叫此函式兩次,一次取得清單的大小,第二次取得實際清單,請將此參數設定為在第一次呼叫時 TRUE,並在第二次呼叫時 FALSE。 如果兩個呼叫都 TRUE,則第二個呼叫也可能傳回PDH_MORE_DATA,因為對象數據可能會在呼叫之間變更。
價值 | 意義 |
---|---|
|
物件快取會在傳回物件之前自動重新整理。 |
|
請勿自動重新整理快取。 |
傳回值
如果函式成功,則會傳回ERROR_SUCCESS。
如果函式失敗,傳回值是 系統錯誤碼 或 PDH 錯誤碼。 以下是可能的值。
傳回碼 | 描述 |
---|---|
|
mszObjectList 緩衝區太小,無法保存物件清單。 如果輸入時 pcchBufferLength 為零,則應該傳回值。 如果輸入上的指定大小大於零,但小於所需的大小,則不應該依賴傳回的大小來重新配置緩衝區。 |
|
指定的電腦離線或無法使用。 |
|
找不到指定的物件。 |
|
參數無效。 例如,在某些版本中,如果輸入上的指定大小大於零,但小於所需的大小,您可能會收到此錯誤。 |
言論
您應該呼叫此函式兩次,第一次取得所需的緩衝區大小(將 mszObjectList 設為 NULL,pcchBufferLength 為 0),第二次取得數據。
注意
pdh.h 標頭會根據 UNICODE 預處理器常數的定義,將 PdhEnumObjectsH 定義為自動選取此函式的 ANSI 或 Unicode 版本。 混合使用編碼中性別名與非編碼中性的程序代碼,可能會導致編譯或運行時間錯誤不符。 如需詳細資訊,請參閱函式原型的
要求
要求 | 價值 |
---|---|
最低支援的用戶端 | Windows XP [僅限傳統型應用程式] |
支援的最低伺服器 | Windows Server 2003 [僅限傳統型應用程式] |
目標平臺 | 窗戶 |
標頭 | pdh.h |
連結庫 | Pdh.lib |
DLL | Pdh.dll |