PdhLookupPerfNameByIndexA, fonction (pdh.h)

Article
11/20/2024

Retourne le nom de l’objet de performance ou le nom du compteur correspondant à l’index spécifié.

Syntaxe

PDH_FUNCTION PdhLookupPerfNameByIndexA(
  [in]      LPCSTR  szMachineName,
  [in]      DWORD   dwNameIndex,
  [out]     LPSTR   szNameBuffer,
  [in, out] LPDWORD pcchNameBufferSize
);

Paramètres

[in] szMachineName

chaîne null-terminated qui spécifie le nom de l’ordinateur où se trouve l’objet ou le compteur de performances spécifié. Le nom de l’ordinateur peut être spécifié par le nom DNS ou l’adresse IP. Si NULL, la fonction utilise l’ordinateur local.

[in] dwNameIndex

Index de l’objet ou du compteur de performances.

[out] szNameBuffer

Mémoire tampon allouée par l’appelant qui reçoit le nom null-terminated name of the performance object or counter. Défini sur NULL si pcchNameBufferSize est égal à zéro.

[in, out] pcchNameBufferSize

Taille de la mémoire tampon de szNameBuffer, dans TCHARs . Si zéro sur 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 compter sur la taille retournée pour réallouer la mémoire tampon.

Valeur de retour

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.

Retourner le code	Description
PDH_MORE_DATA	La mémoire tampon szNameBuffer n’est pas suffisamment grande pour contenir le nom du compteur. Cette valeur de retour est attendue si pcchNameBufferSize est égal à 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 compter sur la taille retournée pour réallouer la mémoire tampon.
PDH_INVALID_ARGUMENT	Un paramètre n’est pas valide ou n’est pas correctement mis en forme. 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.

Remarques

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

Windows XP : Vous devez spécifier une taille de mémoire tampon et de mémoire tampon. La fonction définit pcchNameBufferSize à la taille requise ou à la taille de la mémoire tampon utilisée. Si la mémoire tampon est trop petite, la fonction retourne PDH_INSUFFICIENT_BUFFER au lieu de PDH_MORE_DATA. La taille maximale de chaîne en octets est PDH_MAX_COUNTER_NAME * sizeof(TCHAR).

La valeur d’index que vous spécifiez doit correspondre à l’une des valeurs d’index associées aux objets ou compteurs chargés sur l’ordinateur. Les paires valeur d’index/nom sont stockées dans les Counters valeur de Registre dans l’emplacement de Registre suivant.

HKEY_LOCAL_MACHINE
   \SOFTWARE
      \Microsoft
         \Windows NT
            \CurrentVersion
               \Perflib
                  Last Counter = highest counter index
                  Last Help = highest help index
                  \009
                     Counters = 2 System 4 Memory...
                     Help = 3 The System Object Type...
                  \supported language, other than English
                     Counters = ...
                     Help = ...

Note

L’en-tête pdh.h définit PdhLookupPerfNameByIndex comme 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.

Exigences

Exigence	Valeur
client minimum pris en charge	Windows XP [applications de bureau uniquement]
serveur minimum pris en charge	Windows Server 2003 [applications de bureau uniquement]
plateforme cible	Windows
d’en-tête	pdh.h
bibliothèque	Pdh.lib
DLL	Pdh.dll

Voir aussi

PdhLookupPerfIndexByName

Partager via