Méthode IWbemPathKeyList ::GetKey (wmiutils.h)

La méthode IWbemPathKeyList ::GetKey récupère le nom ou la valeur d’une clé. Les clés sont indexées à partir de 0 (zéro), bien que l’ordre des clés ne soit pas significatif.

Syntaxe

HRESULT GetKey(
  [in]      ULONG  uKeyIx,
  [in]      ULONG  uFlags,
  [in, out] ULONG  *puNameBufSize,
  [in, out] LPWSTR pszKeyName,
  [in, out] ULONG  *puKeyValBufSize,
  [in, out] LPVOID pKeyVal,
  [in, out] ULONG  *puApparentCimType
);

Paramètres

[in] uKeyIx

Index de clé commençant à 0 (zéro).

[in] uFlags

Réservé. Doit être égal à 0 (zéro).

[in, out] puNameBufSize

L’appelant définit ce paramètre sur le nombre de caractères que la mémoire tampon de noms peut contenir. En cas de réussite, ce paramètre est défini sur le nombre de caractères copiés dans la mémoire tampon, y compris la valeur NULL de fin.

[in, out] pszKeyName

Mémoire tampon dans laquelle le nom doit être copié. Étant donné que toutes les clés n’ont pas de nom, cette valeur de paramètre est NULL pour une clé implicite.

[in, out] puKeyValBufSize

L’appelant définit ce paramètre sur le nombre de caractères que la mémoire tampon de valeur peut contenir. En cas de réussite, ce paramètre est défini sur le nombre de caractères copiés dans la mémoire tampon, y compris la terminaison NULL .

[in, out] pKeyVal

Mémoire tampon dans laquelle les données doivent être copiées.

[in, out] puApparentCimType

Pointeur vers un long qui est défini sur le type CIM.

Valeur retournée

Cette méthode retourne une valeur HRESULT qui indique le statut de l'appel de méthode.

Remarques

Il est recommandé de déterminer la taille d’une mémoire tampon en appelant cette méthode, en transmettant un pointeur NULL pour la mémoire tampon et en définissant son paramètre de taille sur 0 (zéro). Lors du retour, le paramètre de taille de la mémoire tampon indique la taille d’une mémoire tampon nécessaire pour la chaîne et sa terminaison NULL . Vous pouvez ensuite appeler la méthode pour obtenir la valeur de la mémoire tampon.

Configuration requise

Voir aussi

IWbemPath

Méthode IWbemPathKeyList

IWbemPathKeyList ::GetKey2