勇芳软件工作室.汉化:  Windows Management Instrumentation > COM API for WMI > Interfaces > IWbemObjectTextSrc >

GetText Method

Previous pageReturn to chapter overviewNext page

描述

 

IWbemObjectTextSrc.GetText方法创建IWbemClassObject对象的文本表示;例如,XML表示。

 

C++ 语法

 

HRESULT GetText(

long lFlags,

IWbemClassObject *pObj,

ULONG uObjTextFormat,

IWbemContext *pCtx,

BSTR *strText

);

 

PowerBASIC 语法

 

METHOD GetText ( _

BYVAL lFlags AS LONG, _

BYVAL pObj AS IWbemClassObject, _

BYVAL uObjTextFormat AS DWORD, _

BYVAL pCtx AS IWbemContext, _

BYREF strText AS WSTRING _

) AS LONG

 

参数

 

lFlags

 

保留。必须为0。

 

pObj

 

引用以文本格式表示的对象。此参数不能为NULL。

 

uObjTextFormat

 

用于表示对象的文本格式的定义。有关此参数的有效值的详细信息,请参阅注释。

 

含义

WMI_OBJ_TEXT_CIM_DTD_2_0

1

&H1

使用对应于CIM DTD 2.0版的DTD。

WMI_OBJ_TEXT_WMI_DTD_2_0

2

&H2

使用与CIM DTD 2.0版相对应的WMI DTD。使用此值可启用特定于WMI的扩展,例如嵌入对象或作用域。

WMI_OBJ_TEXT_WMI_EXT1

3

&H3

留作将来使用。

WMI_OBJ_TEXT_WMI_EXT2

4

&H4

留作将来使用。

WMI_OBJ_TEXT_WMI_EXT3

5

&H5

留作将来使用。

WMI_OBJ_TEXT_WMI_EXT4

6

&H6

留作将来使用。

WMI_OBJ_TEXT_WMI_EXT5

7

&H7

留作将来使用。

WMI_OBJ_TEXT_WMI_EXT6

8

&H8

留作将来使用。

WMI_OBJ_TEXT_WMI_EXT7

9

&H9

留作将来使用。

WMI_OBJ_TEXT_WMI_EXT8

10

&HA

留作将来使用。

WMI_OBJ_TEXT_WMI_EXT9

11

&HB

留作将来使用。

WMI_OBJ_TEXT_WMI_EXT10

12

&HC

留作将来使用。

WMI_OBJ_TEXT_LAST

13

&HD

留作将来使用。

 

pCtx

 

可选的。操作的上下文对象。上下文对象可用于指定对象的某些部分是否以文本形式表示;例如,是否在文本表示中包含限定符。上下文对象采用以下可选值。

 

含义

LocalOnly

VT_BOOL

如果为TRUE,则只有本地定义的属性和方法存在于生成的XML中。默认值为FALSE。

IncludeQualifiers

VT_BOOL

如果为TRUE,则类,实例,属性和方法的限定符将包含在输出中。默认值为FALSE。

PathLevel

VT_I4

默认值为0(零)。

 

可能的值是:

 

·0

 

根据对象是类还是实例,创建<类>或<INSTANCE >元素。

 

·1

 

生成<VALUE.NAMEDOBJECT >元素。

 

·2

 

元素生成了一个VALUE。<元素。

 

·3

 

生成<VALUE.OBJECTWITHPATH >元素。

ExcludeSystemProperties

VT_BOOL

如果为TRUE,系统属性(如__NAMESPACE)在输出中不存在。默认值为FALSE。

IncludeClassOrigin

VT_BOOL

如果为TRUE,则起始属性在<PROPERTY >和<METHOD >元素上设置。默认值为FALSE。

 

strText

 

对象的文本表示。

 

返回值

 

此方法返回一个HRESULT,表示方法调用的状态。下表列出了HRESULT中包含的值。

 

退货代码

描述

WBEM_S_NO_ERROR

成功。

WBEM_E_NOT_FOUND

请求的格式未找到。

WBEM_E_INVALID_PARAMETER

指定了无效参数。

WBEM_E_CRITICAL_ERROR

内部错误。

 

备注

 

有关详细信息,请参阅用XML表示对象.

 

要求

 

客户

需要Windows Vista或Windows XP。

服务器

需要Windows Server 2008或Windows Server 2003。

在Wbemcli.inc中声明。

DLL

需要Fastprox.dll。