Метод SWbemObjectEx.GetText_

Статья
07/14/2023

Метод GetText_ объекта SWbemObjectEx возвращает XML-представление объекта или экземпляра. Текстовый файл имеет формат XML, указанный в WbemObjectTextFormatEnum.

Описание этого синтаксиса см. в разделе Соглашения о документах для API сценариев.

Синтаксис

strObj = .GetText_( _
  ByVal iTextFormat, _
  [ ByVal iFlags ], _
  [ ByVal objWbemNamedValueSet ] _
)

Параметры

iTextFormat [in]: Обязательный. Значение из WbemObjectTextFormatEnum , указывающее результирующий формат XML.
iFlags [in, необязательный]: Флаги зарезервированных операций. Значение по умолчанию — 0 (нуль).
objWbemNamedValueSet [in, необязательный]: Объект SWbemNamedValueSet , который задает контекст для операции. Значение по умолчанию — NULL. Дополнительные сведения о разрешенных парах "имя-значение" см. в разделе Примечания ниже.

Возвращаемое значение

Этот метод не имеет возвращаемых значений.

Коды ошибок

После завершения метода GetText_ объект Err может содержать один из кодов ошибок в следующем списке.

wbemErrFailed — 2147749889 (0x80041001): Незаданная ошибка.
wbemErrNotFound — 2147749890 (0x80041002): Запрошенный формат не найден.
wbemErrInvalidParameter — 2147749896 (0x80041008): Один из параметров вызова указан неправильно.
wbemErrCriticalError — 2147749898 (0x8004100A): Произошла внутренняя, критическая, неожиданная ошибка. Отправьте отчет об этой ошибке в службу технической поддержки корпорации Майкрософт.

Имя	Значение
LocalOnly	VT_BOOL Если задано значение TRUE, в результирующем XML-коде присутствуют только локально определенные свойства и методы. Значение по умолчанию — FALSE.
IncludeQualifiers	VT_BOOL Если задано значение TRUE, квалификаторы классов, экземпляров, свойств и методов включаются в результирующий XML-код. Значение по умолчанию — FALSE.
PathLevel	VT-I4 Значение по умолчанию — 0 (ноль). Возможны следующие значения: 0. Элемент <CLASS> или <INSTANCE> создается в зависимости от того, является ли объект классом или экземпляром. 1: <ЗНАЧЕНИЕ. Создается элемент NAMEDOBJECT> . 2: >ЗНАЧЕНИЕ. Создается элемент OBJECTWITHLOCALPATH> . 3: >ЗНАЧЕНИЕ. Создается элемент OBJECTWITHPATH> .
ExcludeSystemProperties	VT-BOOL Если задано значение TRUE, системные свойства, такие как __NAMESPACE, исключаются из выходных данных.
IncludeClassOrigin	VT_BOOL Если задано значение TRUE, атрибут источника класса задается в элементах >PROPERTY> и >METHOD> . Значение по умолчанию — FALSE.

Дополнительные сведения о создании SWbemNamedValueSet см. в разделе SWbemNamedValueSet.Add.

Примеры

В следующем скрипте показано, как получить XML-представление определения класса Win32_Bios . Указав конкретный экземпляр Win32_Bios, можно получить данные этого объекта в ФОРМАТЕ XML.

' Connect to the default namespace (root\cimv2) with the default
' impersonation level ("impersonate") and obtain a Win32_Bios class
' object.
Set obj = GetObject("winmgmts:win32_bios")

' Use the value for the desired XML CIM DTD format. 
XMLDtd = 1
Text = obj.GetText_(XMLDtd)
wscript.echo Text

Требования

Требование	Значение
Минимальная версия клиента	Windows Vista
Минимальная версия сервера	Windows Server 2008
Заголовок	Wbemdisp.h
Библиотека типов	Wbemdisp.tlb
DLL	Wbemdisp.dll
CLSID	CLSID_SWbemObjectEx
IID	IID_ISWbemObjectEx