Método SWbemObjectEx.GetText_

  • Artigo

O método GetText_ do objeto SWbemObjectEx retorna uma representação XML de um objeto ou uma instância. O arquivo de texto é formatado em XML especificado conforme mostrado em WbemObjectTextFormatEnum.

Para ver uma explicação dessa sintaxe, confira Convenções de documento para a API de script.

Sintaxe

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

Parâmetros

iTextFormat [entrada]

Obrigatórios. Um valor de WbemObjectTextFormatEnum que especifica o formato XML resultante.

iFlags [entrada, opcional]

Sinalizadores de operação reservados. O valor padrão é 0 (zero).

objWbemNamedValueSet [entrada, opcional]

Um objeto SWbemNamedValueSet que define o contexto para a operação. O padrão é nulo. Para obter mais informações sobre os pares nome/valor permitidos, veja os Comentários abaixo.

Retornar valor

Esse método não tem valores retornados.

Códigos do Erro

Após a conclusão do método GetText_, o objeto Err pode conter um dos códigos de erro na lista a seguir.

wbemErrFailed – 2147749889 (0x80041001)

Erro não especificado.

wbemErrNotFound – 2147749890 (0x80041002)

O formato solicitado não foi encontrado.

wbemErrInvalidParameter – 2147749896 (0x80041008)

Um dos parâmetros para a chamada não está correto.

wbemErrCriticalError – 2147749898 (0x8004100A)

Ocorreu um erro interno, crítico e inesperado. Relate este erro ao Suporte Técnico da Microsoft.

Comentários

Ao construir seu SWbemNamedValueSet, somente os pares nome/valor a seguir são permitidos.

Nome Valor
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 no XML resultante. 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, serão excluídas da saída.
IncludeClassOrigin VT_BOOL
Se TRUE, o atributo de origem da classe será definido nos >elementos PROPERTY> e >METHOD> . O padrão é FALSE.

Para obter mais informações sobre como criar um SWbemNamedValueSet, confira SWbemNamedValueSet.Add.

Exemplos

O script a seguir mostra como obter uma representação XML da definição de classe Win32_Bios. Ao especificar uma instância específica do Win32_Bios, você pode obter os dados desse objeto em 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

Requisitos

Requisito Valor
Cliente mínimo com suporte
 Windows Vista
Servidor mínimo com suporte
 Windows Server 2008
Cabeçalho
Wbemdisp.h
Biblioteca de tipos
Wbemdisp.tlb
DLL
Wbemdisp.dll
CLSID
 CLSID_SWbemObjectEx
IID
 IID_ISWbemObjectEx