PdhParseInstanceNameA 函式 (pdh.h)
剖析實例字串的專案。
語法
PDH_FUNCTION PdhParseInstanceNameA(
[in] LPCSTR szInstanceString,
[out] LPSTR szInstanceName,
[in, out] LPDWORD pcchInstanceNameLength,
[out] LPSTR szParentName,
[in, out] LPDWORD pcchParentNameLength,
[out] LPDWORD lpIndex
);
參數
[in] szInstanceString
Null 終止的字串,指定要剖析成個別元件的實例字串。 此字串可以包含下列格式,且長度小於MAX_PATH個字元:
- instance
- instance#index
- 父/實例
- parent/instance#index
[out] szInstanceName
接收 Null 終止實例名稱的呼叫端配置緩衝區。 如果pcchInstanceNameLength為零,請將 設定為NULL。
[in, out] pcchInstanceNameLength
SZInstanceName 緩衝區的大小,以 TCHAR 為單位。 如果輸入為零,則函式會傳回PDH_MORE_DATA,並將此參數設定為必要的緩衝區大小。 如果緩衝區大於所需的大小,函式會將此參數設定為所使用之緩衝區的實際大小。 如果輸入上的指定大小大於零,但小於所需的大小,您就不應該依賴傳回的大小來重新配置緩衝區。
[out] szParentName
呼叫端配置的緩衝區,如果指定了父實例,則會接收 null 終止名稱。 如果pcchParentNameLength為零,請將 設定為NULL。
[in, out] pcchParentNameLength
SzParentName 緩衝區的大小,以 TCHAR 為單位。 如果輸入為零,則函式會傳回PDH_MORE_DATA,並將此參數設定為必要的緩衝區大小。 如果緩衝區大於所需的大小,函式會將此參數設定為所使用之緩衝區的實際大小。 如果輸入上的指定大小大於零,但小於所需的大小,您就不應該依賴傳回的大小來重新配置緩衝區。
[out] lpIndex
實例的索引值。 如果字串中沒有索引專案,則此值為零。 此參數可以是 Null。
傳回值
如果函式成功,它會傳回ERROR_SUCCESS。
如果函式失敗,傳回值為 系統錯誤碼 或 PDH 錯誤碼。 以下是可能的值。
傳回碼 | Description |
---|---|
|
參數無效。 例如,在某些版本中,如果輸入上的指定大小大於零,但小於所需的大小,您可能會收到此錯誤。 |
|
一或兩個字串緩衝區太小而無法包含數據。 如果輸入上的對應大小緩衝區為零,則此傳回值是預期的。 如果輸入上的指定大小大於零,但小於所需的大小,您就不應該依賴傳回的大小來重新配置緩衝區。 |
|
實例字串的格式不正確、超過長度MAX_PATH字元,或無法剖析。 |
備註
您應該呼叫此函式兩次,第一次取得所需的緩衝區大小 (將緩衝區設定為 NULL ,並將緩衝區大小設定為 0) ,第二次取得數據。
注意
pdh.h 標頭會根據 UNICODE 預處理器常數的定義,將 PdhParseInstanceName 定義為別名,自動選取此函式的 ANSI 或 Unicode 版本。 混合使用編碼中性別名與非編碼中性的程序代碼,可能會導致編譯或運行時間錯誤不符。 如需詳細資訊,請參閱 函式原型的慣例。
規格需求
需求 | 值 |
---|---|
最低支援的用戶端 | Windows XP [僅限傳統型應用程式] |
最低支援的伺服器 | Windows Server 2003 [僅限傳統型應用程式] |
目標平台 | Windows |
標頭 | pdh.h |
程式庫 | Pdh.lib |
Dll | Pdh.dll |