IWbemObjectTextSrc::GetText 方法 (wbemcli.h)
IWbemObjectTextSrc::GetText 方法创建 IWbemClassObject 对象的文本表示形式;例如,XML 表示形式。
语法
HRESULT GetText(
long lFlags,
IWbemClassObject *pObj,
ULONG uObjTextFormat,
IWbemContext *pCtx,
BSTR *strText
);
参数
lFlags
保留。 必须为 0L。
pObj
对要以文本格式表示的 对象的引用。 此参数不能为 NULL。
uObjTextFormat
用于表示对象的文本格式的定义。 有关此参数的有效值的详细信息,请参阅备注。
WMI_OBJ_TEXT_CIM_DTD_2_0 (1 (0x1) )
使用与 CIM DTD 版本 2.0 相对应的 DTD。
WMI_OBJ_TEXT_WMI_DTD_2_0 (2 (0x2) )
使用与 CIM DTD 版本 2.0 相对应的 WMI DTD。 使用此值可启用特定于 WMI 的扩展,例如嵌入的对象或范围。
WMI_OBJ_TEXT_WMI_EXT1 (3 (0x3) )
保留供将来使用。
WMI_OBJ_TEXT_WMI_EXT2 (4 (0x4) )
保留供将来使用。
WMI_OBJ_TEXT_WMI_EXT3 (5 (0x5) )
保留供将来使用。
WMI_OBJ_TEXT_WMI_EXT4 (6 (0x6) )
保留供将来使用。
WMI_OBJ_TEXT_WMI_EXT5 (7 (0x7) )
保留供将来使用。
WMI_OBJ_TEXT_WMI_EXT6 (8 (0x8) )
保留供将来使用。
WMI_OBJ_TEXT_WMI_EXT7 (9 (0x9) )
保留供将来使用。
WMI_OBJ_TEXT_WMI_EXT8 (10 (0xA) )
保留供将来使用。
WMI_OBJ_TEXT_WMI_EXT9 (11 (0xB) )
保留供将来使用。
WMI_OBJ_TEXT_WMI_EXT10 (12 (0xC) )
保留供将来使用。
WMI_OBJ_TEXT_LAST (13 (0xD) )
保留供将来使用。
pCtx
可选。 操作的上下文对象。 上下文对象可用于指定对象的某些部分是否以文本形式表示;例如,是否在文本表示形式中包含限定符。 上下文对象采用以下可选值。
LocalOnly (VT_BOOL)
如果为 TRUE,则生成的 XML 中只存在本地定义的属性和方法。 默认值为 FALSE。
IncludeQualifiers (VT_BOOL)
如果 为 TRUE,则输出中包含类、实例、属性和方法的限定符。 默认值为 FALSE。
PathLevel (VT_I4)
默认值为 0(零)。
可能的值为:
-
0
根据对象是类还是实例创建 CLASS 或 INSTANCE 元素。
-
1
值。生成 NAMEDOBJECT 元素。
-
2
值。生成 OBJECTWITHLOCALPATH 元素。
-
3
值。生成 OBJECTWITHPATH 元素。
ExcludeSystemProperties (VT_BOOL)
如果 为 TRUE,则输出中不存在系统属性(如 __NAMESPACE)。 默认值为 FALSE。
IncludeClassOrigin (VT_BOOL)
如果 为 TRUE,则对 PROPERTY 和 METHOD 元素设置类原点属性。 默认值为 FALSE。
strText
对象的文本表示形式。 使用 strText 完成后,用户必须使用 SysFreeString 释放字符串。
返回值
此方法返回指示方法调用状态的 HRESULT。 以下列表列出了 HRESULT 中包含的值。
注解
有关详细信息,请参阅 在 XML 中表示对象。
要求
要求 | 值 |
---|---|
最低受支持的客户端 | Windows Vista |
最低受支持的服务器 | Windows Server 2008 |
目标平台 | Windows |
标头 | wbemcli.h (包括 Wbemidl.h) |
Library | Wbemuuid.lib |
DLL | Fastprox.dll |