Compartir a través de

Función GetObjectText

  • Artículo

Esta función puede usarse para obtener una representación textual de un objeto con la sintaxis Managed Object Format (MOF).

Nota

Esta API es solo para uso interno. No está pensada para usarla desde código del desarrollador.

Sintaxis

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

Parámetros

vFunc
[in] Este parámetro no se usa.

ptr
[in] El valor de este parámetro se corresponde con un puntero que apunta a una instancia de la interfaz IWbemClassObject.

lFlags
[in] El valor de este parámetro suele ser de 0. Si se especifica la marca WBEM_FLAG_NO_FLAVORS (o 0x1), se incluirán los calificadores sin información sobre la propagación o el tipo.

pstrObjectText [out] El valor de este parámetro se corresponde con un puntero que apunta a un valor null en el proceso de entrada de la función. En el proceso de la salida, este apuntará a un objeto BSTR recién asignado que contendrá una representación del objeto con la sintaxis MOF.

Valor devuelto

Los siguientes valores que devuelve esta función se definen en el archivo de encabezado WbemCli.h, aunque también puede definirlos como constantes en el código. Puede consultarlos a continuación:

Constante Value Descripción
WBEM_E_FAILED 0x80041001 Si se devuelve este valor, significará que se ha producido un error general.
WBEM_E_INVALID_PARAMETER 0x80041008 Un parámetro no es válido.
WBEM_E_OUT_OF_MEMORY 0x80041006 Memoria insuficiente para completar la operación.
WBEM_S_NO_ERROR 0 Si se devuelve este valor, significará que la llamada a la función se realizó correctamente.

Comentarios

Al usar esta función, se ajusta una llamada al método IWbemClassObject::GetObjectText.

El texto MOF que se devuelva no contendrá toda la información sobre el objeto, sino la información suficiente para que el compilador MOF pueda volver a crear el objeto original. Por ejemplo, no se incluirán ni los calificadores propagados ni las propiedades de clase primaria.

El siguiente algoritmo se usa para reconstruir el texto de los parámetros de un método:

  1. Los parámetros se vuelven a poner en cola según el orden de sus valores de identificador.
  2. Los parámetros que se especifiquen tanto como de entrada ([in]) como de salida ([out]) se combinarán en un único parámetro.

El valor del parámetro pstrObjectText debe corresponderse con un puntero que apunte a un valor null cuando se llame a la función; no deberá apuntar a una cadena que sea válida antes de que se realice la llamada al método, ya que ese puntero no se desasignará.

Requisitos

Plataformas: Vea Requisitos de sistema.

Encabezado: WMINet_Utils.idl

Versiones de .NET Framework: está disponible desde la versión 4.7.2

Consulte también