PdhExpandWildCardPathHA, fonction (pdh.h)

  • Article

Examine l’ordinateur ou le fichier journal spécifié et retourne les chemins de compteur qui correspondent au chemin du compteur donné qui contient des caractères génériques.

Cette fonction est identique à la fonction PdhExpandWildCardPath , sauf qu’elle prend en charge l’utilisation de handles pour les sources de données.

Syntaxe

PDH_FUNCTION PdhExpandWildCardPathHA(
  [in]      PDH_HLOG hDataSource,
  [in]      LPCSTR   szWildCardPath,
  [out]     PZZSTR   mszExpandedPathList,
  [in, out] LPDWORD  pcchPathListLength,
  [in]      DWORD    dwFlags
);

Paramètres

[in] hDataSource

Gérez une source de données retournée par la fonction PdhBindInputDataSource .

[in] szWildCardPath

Chaîne terminée par null qui spécifie le chemin d’accès du compteur à développer. La longueur maximale d’un chemin de compteur est PDH_MAX_COUNTER_PATH.

Si hDataSource est une source de données en temps réel, la fonction recherche des correspondances sur l’ordinateur spécifié dans le chemin d’accès. Si le chemin d’accès ne spécifie pas d’ordinateur, la fonction recherche l’ordinateur local.

[out] mszExpandedPathList

Mémoire tampon allouée à l’appelant qui reçoit une liste de chemins de compteurs terminés par null qui correspondent à la spécification générique dans le szWildCardPath. La liste est terminée par deux caractères NULL . Défini sur NULL si pcchPathListLength est égal à zéro.

[in, out] pcchPathListLength

Taille de la mémoire tampon mszExpandedPathList , dans les TCHAR. Si zéro à l’entrée et que l’objet existe, la fonction retourne PDH_MORE_DATA et définit ce paramètre sur la taille de mémoire tampon requise. Si la mémoire tampon est supérieure à la taille requise, la fonction définit ce paramètre sur la taille réelle de la mémoire tampon utilisée. Si la taille spécifiée sur l’entrée est supérieure à zéro mais inférieure à la taille requise, vous ne devez pas compter sur la taille retournée pour réallouer la mémoire tampon.

Note Vous devez en ajouter un à la taille requise sur Windows XP.
 

[in] dwFlags

Indicateurs qui indiquent les caractères génériques à ne pas développer. Vous pouvez spécifier un ou plusieurs indicateurs.

Valeur Signification
PDH_NOEXPANDCOUNTERS
 Ne développez pas le nom du compteur si le chemin d’accès contient un caractère générique pour le nom du compteur.
PDH_NOEXPANDINSTANCES
 Ne développez pas le nom du instance si le chemin d’accès contient un caractère générique pour le instance parent, le nom instance ou l’index instance.
PDH_REFRESHCOUNTERS
 Actualisez la liste des compteurs.

Valeur retournée

Si la fonction réussit, elle retourne ERROR_SUCCESS.

Si la fonction échoue, la valeur renvoyée est un code d’erreur système ou un code d’erreur PDH.

Code de retour Description
PDH_MORE_DATA
 La mémoire tampon mszExpandedPathList n’est pas assez grande pour contenir la liste des chemins d’accès. Cette valeur de retour est attendue si pcchPathListLength est égal à zéro en entrée. Si la taille spécifiée sur l’entrée est supérieure à zéro mais inférieure à la taille requise, vous ne devez pas compter sur la taille retournée pour réallouer la mémoire tampon.
PDH_INVALID_ARGUMENT
 Un paramètre n'est pas valide. Par exemple, sur certaines versions, vous pouvez recevoir cette erreur si la taille spécifiée sur l’entrée est supérieure à zéro, mais inférieure à la taille requise.
PDH_MEMORY_ALLOCATION_FAILURE
 Impossible d’allouer de la mémoire pour prendre en charge cette fonction.
PDH_CSTATUS_NO_OBJECT
 Impossible de trouver l’objet spécifié sur l’ordinateur ou dans le fichier journal.

Notes

Vous devez appeler cette fonction deux fois, la première fois pour obtenir la taille de mémoire tampon requise ( définissez mszExpandedPathList surNULL et pcchPathListLength sur 0) et la deuxième fois pour obtenir les données.

PdhExpandWildCardPathH diffère de PdhExpandCounterPath des manières suivantes :

  1. Vous permet de contrôler les caractères génériques qui sont développés.
  2. Le contenu d’un fichier journal peut être utilisé comme source de noms de compteurs.
Le format général du chemin d’accès du compteur est le suivant :

\computer\object(parent/instance#index)\counter

Les composants parent, instance, index et compteur du chemin d’accès du compteur peuvent contenir un nom valide ou un caractère générique. Les composants ordinateur, parent, instance et index ne sont pas nécessaires pour tous les compteurs.

Voici la liste des formats possibles :

  • \\computer\object(parent/instance#index)\counter
  • \\computer\object(parent/instance)\counter
  • \\computer\object(instance#index)\counter
  • \\computer\object(instance)\counter
  • \\computer\object\counter
  • \object(parent/instance#index)\counter
  • \object(parent/instance)\counter
  • \object(instance#index)\counter
  • \object(instance)\counter
  • \object\counter
Utilisez un astérisque (*) comme caractère générique, par exemple, \object(*)\counter.

Si un caractère générique est spécifié dans le nom parent, toutes les instances de l’objet spécifié qui correspondent aux champs de instance et de compteur spécifiés sont retournées. Par exemple, \object(*/instance)\counter.

Si un caractère générique est spécifié dans le nom instance, toutes les instances de l’objet et de l’objet parent spécifiés sont retournées si tous les noms instance correspondant à l’index spécifié correspondent au caractère générique. Par exemple, \object(parent/*)\counter.

Si un caractère générique est spécifié dans le nom du compteur, tous les compteurs de l’objet spécifié sont retournés.

Les correspondances de chaîne de chemin de compteur partiel (par exemple, « pro* ») sont prises en charge.

Avant Windows Vista : Les correspondances génériques partielles ne sont pas prises en charge.

Notes

L’en-tête pdh.h définit PdhExpandWildCardPathH comme un alias qui sélectionne automatiquement la version ANSI ou Unicode de cette fonction en fonction de la définition de la constante de préprocesseur UNICODE. Le mélange de l’utilisation de l’alias neutre en encodage avec du code qui n’est pas neutre en encodage peut entraîner des incompatibilités qui entraînent des erreurs de compilation ou d’exécution. Pour plus d’informations, consultez Conventions pour les prototypes de fonction.

Spécifications

   
Client minimal pris en charge Windows XP [applications de bureau uniquement]
Serveur minimal pris en charge Windows Server 2003 [applications de bureau uniquement]
Plateforme cible Windows
En-tête pdh.h
Bibliothèque Pdh.lib
DLL Pdh.dll

Voir aussi

PdhBindInputDataSourceA, fonctionPdhEnumObjectItemsHA, fonctionPdhEnumObjectsHA, fonctionPdhExpandCounterPathA, fonction