Método IWbemObjectTextSrc::GetText (wbemcli.h)

  • Artigo

O método IWbemObjectTextSrc::GetText cria uma representação textual de um objeto IWbemClassObject ; por exemplo, uma representação XML.

Sintaxe

HRESULT GetText(
  long             lFlags,
  IWbemClassObject *pObj,
  ULONG            uObjTextFormat,
  IWbemContext     *pCtx,
  BSTR             *strText
);

Parâmetros

lFlags

Reservado. Deve ser 0L.

pObj

Referência ao objeto a ser representado no formato de texto. Esse parâmetro não pode ser NULL.

uObjTextFormat

Definição do formato de texto usado para representar o objeto . Para obter mais informações sobre valores válidos para esse parâmetro, consulte Comentários.

WMI_OBJ_TEXT_CIM_DTD_2_0 (1 (0x1))

Use o DTD que corresponde ao CIM DTD versão 2.0.

WMI_OBJ_TEXT_WMI_DTD_2_0 (2 (0x2))

Use o DTD WMI que corresponde ao CIM DTD versão 2.0. O uso desse valor permite extensões específicas do WMI, como objetos inseridos ou escopo.

WMI_OBJ_TEXT_WMI_EXT1 (3 (0x3))

Reservado para uso futuro.

WMI_OBJ_TEXT_WMI_EXT2 (4 (0x4))

Reservado para uso futuro.

WMI_OBJ_TEXT_WMI_EXT3 (5 (0x5))

Reservado para uso futuro.

WMI_OBJ_TEXT_WMI_EXT4 (6 (0x6))

Reservado para uso futuro.

WMI_OBJ_TEXT_WMI_EXT5 (7 (0x7))

Reservado para uso futuro.

WMI_OBJ_TEXT_WMI_EXT6 (8 (0x8))

Reservado para uso futuro.

WMI_OBJ_TEXT_WMI_EXT7 (9 (0x9))

Reservado para uso futuro.

WMI_OBJ_TEXT_WMI_EXT8 (10 (0xA))

Reservado para uso futuro.

WMI_OBJ_TEXT_WMI_EXT9 (11 (0xB))

Reservado para uso futuro.

WMI_OBJ_TEXT_WMI_EXT10 (12 (0xC))

Reservado para uso futuro.

WMI_OBJ_TEXT_LAST (13 (0xD))

Reservado para uso futuro.

pCtx

Opcional. Objeto de contexto para a operação. O objeto de contexto pode ser usado para especificar se determinadas partes do objeto são representadas no texto; por exemplo, se deseja incluir qualificadores na representação textual. O objeto de contexto usa os seguintes valores opcionais.

LocalOnly (VT_BOOL)

Se for TRUE, somente propriedades e métodos definidos localmente estarão presentes no XML resultante. O padrão é FALSE.

IncludeQualifiers (VT_BOOL)

Se TRUE, os qualificadores de classes, instâncias, propriedades e métodos serão incluídos na saída. O padrão é FALSE.

PathLevel (VT_I4)

O padrão é 0 (zero).

Os valores possíveis são:

  • 0

    Um elemento CLASS ou INSTANCE é criado dependendo se o objeto é uma classe ou instância.

  • 1

    UM VALOR. O elemento NAMEDOBJECT é gerado.

  • 2

    UM VALOR. O elemento OBJECTWITHLOCALPATH é gerado.

  • 3

    UM VALOR. O elemento OBJECTWITHPATH é gerado.

ExcludeSystemProperties (VT_BOOL)

Se TRUE, as propriedades do sistema, como __NAMESPACE, estarão ausentes na saída. O padrão é FALSE.

IncludeClassOrigin (VT_BOOL)

Se TRUE, o atributo de origem da classe será definido em elementos PROPERTY e METHOD . O padrão é FALSE.

strText

Representação textual do objeto . O usuário deve liberar a cadeia de caracteres usando SysFreeString quando terminar com strText.

Retornar valor

Esse método retorna um HRESULT que indica o status da chamada de método. A lista a seguir lista o valor contido em um HRESULT.

Comentários

Para obter mais informações, consulte Representando objetos em XML.

Requisitos

Requisito Valor
Cliente mínimo com suporte Windows Vista
Servidor mínimo com suporte Windows Server 2008
Plataforma de Destino Windows
Cabeçalho wbemcli.h (inclua Wbemidl.h)
Biblioteca Wbemuuid.lib
DLL Fastprox.dll