Partilhar via


Função GetObjectText

Devolve uma composição textual do objeto na sintaxe de Formato de Objeto Gerido (MOF).

Nota

Esta API destina-se apenas a utilização interna. Não se destina a ser utilizado a partir do código do programador.

Sintaxe

HRESULT GetObjectText (
   [in] int                vFunc,
   [in] IWbemClassObject*   ptr,
   [in] LONG                lFlags,
   [out] BSTR*              pstrObjectText
);

Parâmetros

vFunc
[in] Este parâmetro não é utilizado.

ptr
[in] Um ponteiro para uma instância IWbemClassObject .

lFlags
[in] Normalmente 0. Se WBEM_FLAG_NO_FLAVORS (ou 0x1) for especificado, os qualificadores são incluídos sem informações de propagação ou sabor.

pstrObjectText [fora] Um ponteiro para uma null entrada. Na devolução, um recém-alocado BSTR que contém uma composição de sintaxe MOF do objeto.

Valor devolvido

Os seguintes valores devolvidos por esta função são definidos no ficheiro de cabeçalho WbemCli.h ou pode defini-los como constantes no seu código:

Constante Valor Descrição
WBEM_E_FAILED 0x80041001 Houve uma falha geral.
WBEM_E_INVALID_PARAMETER 0x80041008 Um parâmetro não é válido.
WBEM_E_OUT_OF_MEMORY 0x80041006 Não existe memória suficiente disponível para concluir a operação.
WBEM_S_NO_ERROR 0 A chamada da função foi efetuada com êxito.

Observações

Esta função encapsula uma chamada para o método IWbemClassObject::GetObjectText .

O texto MOF devolvido não contém todas as informações sobre o objeto, mas apenas informações suficientes para que o compilador do MOF possa recriar o objeto original. Por exemplo, não estão incluídos qualificadores propagados ou propriedades da classe principal.

O algoritmo seguinte é utilizado para reconstruir o texto dos parâmetros de um método:

  1. Os parâmetros são resequencados pela ordem dos respetivos valores de identificador.
  2. Parâmetros que são especificados como [in] e [out] são combinados num único parâmetro.

pstrObjectText tem de ser um ponteiro para um null quando a função é chamada; não pode apontar para uma cadeia válida antes da chamada do método, porque o ponteiro não será desalocado.

Requisitos

Plataformas: Veja Requisitos de Sistema.

Cabeçalho: WMINet_Utils.idl

.NET Framework Versões: Disponível desde a versão 4.7.2

Ver também