GetObjectText 函式
在受控物件格式 (MOF) 語法中傳回物件的文字轉譯。
注意
此 API 僅供內部使用。 不是要讓您在開發人員程式碼中使用。
語法
HRESULT GetObjectText (
[in] int vFunc,
[in] IWbemClassObject* ptr,
[in] LONG lFlags,
[out] BSTR* pstrObjectText
);
參數
vFunc
[in] 此參數未使用。
ptr
[in] IWbemClassObject 執行個體的指標。
lFlags
[in] 通常為 0。 如果指定了 WBEM_FLAG_NO_FLAVORS
(或 0x1),則會包含限定詞但不會有傳播或變體資訊。
pstrObjectText
[out] 項目上 null
的指標。 傳回時,是新配置的 BSTR
,其包含物件的 MOF 語法轉譯。
傳回值
此函式傳回的下列值定義於 WbemCli.h 標頭檔中,或者,您可以將其定義為程式碼中的常數:
常數 | 值 | 描述 |
---|---|---|
WBEM_E_FAILED |
0x80041001 | 發生一般失敗。 |
WBEM_E_INVALID_PARAMETER |
0x80041008 | 參數無效。 |
WBEM_E_OUT_OF_MEMORY |
0x80041006 | 可用的記憶體不足,無法完成作業。 |
WBEM_S_NO_ERROR |
0 | 函式呼叫成功。 |
備註
此函式會包裝對 IWbemClassObject::GetObjectText 方法的呼叫。
傳回的 MOF 文字未包含物件的所有資訊,但只有在資訊足夠時,MOF 編譯器才能夠重新建立原始物件。 例如,不會包含傳播的限定詞或父類別屬性。
下列演算法可用來重新建構方法參數的文字:
- 參數會依其識別碼值的順序重設排序。
- 指定為
[in]
和[out]
的參數會合併成單一參數。
在呼叫函式時,pstrObjectText
必須是 null
的指標;在呼叫方法之前,它不得指向有效字串,因為系統不會將指標解除配置。
規格需求
平台:請參閱系統需求。
標頭:WMINet_Utils.idl
.NET Framework版本:自 4.7.2 起提供