Метод 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))
Используйте DTD, соответствующий DTD CIM версии 2.0.
WMI_OBJ_TEXT_WMI_DTD_2_0 (2 (0x2))
Используйте WMI DTD, соответствующий CIM DTD версии 2.0. Использование этого значения позволяет использовать расширения 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
Текстовое представление объекта . Пользователь должен освободить строку с помощью SysFreeString после завершения работы со strText.
Возвращаемое значение
Этот метод возвращает HRESULT , указывающий состояние вызова метода. В следующем списке перечислены значения, содержащиеся в HRESULT.
Комментарии
Дополнительные сведения см. в разделе Представление объектов в XML.
Требования
Требование | Значение |
---|---|
Минимальная версия клиента | Windows Vista |
Минимальная версия сервера | Windows Server 2008 |
Целевая платформа | Windows |
Header | wbemcli.h (включая Wbemidl.h) |
Библиотека | Wbemuuid.lib |
DLL | Fastprox.dll |