PdhParseInstanceNameA, fonction (pdh.h)

Article
03/01/2024

Analyse les éléments d’une chaîne instance.

Syntaxe

PDH_FUNCTION PdhParseInstanceNameA(
  [in]      LPCSTR  szInstanceString,
  [out]     LPSTR   szInstanceName,
  [in, out] LPDWORD pcchInstanceNameLength,
  [out]     LPSTR   szParentName,
  [in, out] LPDWORD pcchParentNameLength,
  [out]     LPDWORD lpIndex
);

Paramètres

[in] szInstanceString

Chaîne terminée par null qui spécifie la chaîne instance à analyser dans des composants individuels. Cette chaîne peut contenir les formats suivants et est inférieure à MAX_PATH caractères :

instance
instance#index
parent/instance
parent/instance#index

[out] szInstanceName

Mémoire tampon allouée à l’appelant qui reçoit le nom de la instance terminée par null. Définissez sur NULL si pcchInstanceNameLength est égal à zéro.

[in, out] pcchInstanceNameLength

Taille de la mémoire tampon szInstanceName , en TCHAR. Si la valeur est zéro à l’entrée, 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 vous appuyer sur la taille retournée pour réallouer la mémoire tampon.

[out] szParentName

Mémoire tampon allouée à l’appelant qui reçoit le nom terminé par null du instance parent, le cas échéant. Définissez sur NULL si pcchParentNameLength est égal à zéro.

[in, out] pcchParentNameLength

Taille de la mémoire tampon szParentName , en TCHAR. Si la valeur est zéro à l’entrée, 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 vous appuyer sur la taille retournée pour réallouer la mémoire tampon.

[out] lpIndex

Valeur d’index du instance. Si aucune entrée d’index n’est présente dans la chaîne, cette valeur est égale à zéro. Ce paramètre peut être NULL.

Valeur retournée

Si la fonction réussit, elle retourne ERROR_SUCCESS.

Si la fonction échoue, la valeur de retour est un code d’erreur système ou un code d’erreur PDH. Voici les valeurs possibles.

Code de retour	Description
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_MORE_DATA	L’une des mémoires tampons de chaîne ou les deux sont trop petites pour contenir les données. Cette valeur de retour est attendue si la mémoire tampon de taille correspondante est égale à zéro lors de l’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 vous appuyer sur la taille retournée pour réallouer la mémoire tampon.
PDH_INVALID_INSTANCE	La chaîne instance est incorrectement mise en forme, dépasse MAX_PATH caractères ou ne peut pas être analysée.

Remarques

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

Notes

L’en-tête pdh.h définit PdhParseInstanceName en tant qu’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. La combinaison 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.

Configuration requise

Condition requise	Valeur
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

PdhMakeCounterPath

Partager via