Partager via

GetObjectText, fonction

  • Article

Retourne un rendu textuel de l’objet dans la syntaxe MOF (Managed Object Format).

Notes

Cette API est destinée à un usage interne uniquement. Elle n’est pas destinée à être utilisée dans le code du développeur.

Syntaxe

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

Paramètres

vFunc
[in] Ce paramètre est inutilisé.

ptr
[in] Pointeur vers une instance IWbemClassObject.

lFlags
[in] Normalement 0. Si WBEM_FLAG_NO_FLAVORS (ou 0x1) est spécifié, les qualificateurs sont inclus sans informations de propagation ou de saveur.

pstrObjectText [out] Pointeur vers un null à l’entrée. Lors du retour, une nouvelle allocation BSTR qui contient un rendu de syntaxe MOF de l’objet.

Valeur retournée

Les valeurs suivantes renvoyées par cette fonction sont définies dans le fichier d’en-tête WbemCli.h, ou vous pouvez les définir comme constantes dans votre code :

Constant Valeur Description
WBEM_E_FAILED 0x80041001 Il y a eu une défaillance générale.
WBEM_E_INVALID_PARAMETER 0x80041008 Un paramètre n'est pas valide.
WBEM_E_OUT_OF_MEMORY 0x80041006 La mémoire n'est pas suffisante pour terminer cette opération.
WBEM_S_NO_ERROR 0 L’appel de fonction a abouti.

Notes

Cette fonction encapsule un appel à la méthode IWbemClassObject::GetObjectText.

Le texte MOF retourné ne contient pas toutes les informations relatives à l’objet, mais uniquement suffisamment d’informations pour que le compilateur MOF puisse recréer l’objet d’origine. Par exemple, aucun qualificateur propagé ou propriété de classe parente n’est inclus.

L’algorithme suivant est utilisé pour reconstruire le texte des paramètres d’une méthode :

  1. Les paramètres sont resequencés dans l’ordre de leurs valeurs d’identificateur.
  2. Paramètres spécifiés comme [in] et [out] combinés en un seul paramètre.

pstrObjectText doit être un pointeur vers un null lorsque la fonction est appelée ; elle ne doit pas pointer vers une chaîne valide avant l’appel de méthode, car le pointeur ne sera pas désalloué.

Spécifications

Plateformes : Consultez Configuration requise.

En-tête : WMINet_Utils.idl

Versions de .NET Framework : disponibles depuis la version 4.7.2

Voir aussi