Partager via

GetPropertyHandle, fonction

  • Article

Retourne un handle unique qui identifie une propriété.

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 GetPropertyHandle (
   [in] int                  vFunc,
   [in] IWbemObjectAccess*   ptr,
   [in] LPCWSTR              wszPropertyName,
   [out] CIMTYPE*            pType,
   [out] long*               pHandle
);

Paramètres

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

ptr
[in] Pointeur vers une instance IWbemObjectAccess.

wszPropertyName
[in] Chaîne terminée par null de caractères encodés en UTF16 qui contient le nom de la propriété.

pType
[out] Pointeur vers un membre d’énumération CIMTYPE qui représente le type CIM de la propriété.

pHandle
[out] Pointeur vers un entier qui contient le descripteur de propriété.

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_NOT_FOUND 0x80041002 Le nom de propriété spécifié est introuvable.
WBEM_E_INVALID_PARAMETER 0x80041008 Un paramètre n'est pas valide.
WBEM_E_NOT_SUPPORTED 0x8004100c La propriété demandée est de type CIM_OBJECT ou CIM_ARRAY.
WBEM_S_NO_ERROR 0 L’appel de fonction a abouti.

Notes

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

Vous pouvez utiliser ce descripteur pour identifier les propriétés lors de l’utilisation des méthodes IWbemObjectAccess pour lire ou écrire des valeurs de propriété.

Les descripteurs peuvent être récupérés pour les propriétés de tous les types de données autres que CIM_OBJECT et CIM_ARRAY. Les descripteurs retournés fonctionnent sur toutes les instances d’une classe.

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