PdhGetDefaultPerfObjectA, fonction (pdh.h)

Article
11/20/2024

Récupère le nom de l’objet par défaut. Ce nom peut être utilisé pour définir la sélection initiale de l’objet dans la boîte de dialogue Parcourir le compteur.

Pour utiliser des handles vers des sources de données, utilisez la fonction PdhGetDefaultPerfObjectH.

Syntaxe

PDH_FUNCTION PdhGetDefaultPerfObjectA(
  [in]      LPCSTR  szDataSource,
  [in]      LPCSTR  szMachineName,
  [out]     LPSTR   szDefaultObjectName,
  [in, out] LPDWORD pcchBufferSize
);

Paramètres

[in] szDataSource

Doit être NULL.

Si vous spécifiez un fichier journal, le paramètre szDefaultObjectName est une chaîne de null .

[in] szMachineName

chaîne null-terminated qui spécifie le nom de l’ordinateur utilisé pour vérifier le nom de l’objet. Si NULL, l’ordinateur local est utilisé pour vérifier le nom.

[out] szDefaultObjectName

Mémoire tampon allouée par l’appelant qui reçoit le nom d’objet par défaut null. Défini sur NULL si le paramètre pcchBufferSize est égal à zéro.

Notez que PDH retourne toujours processor pour le nom d’objet par défaut.

[in, out] pcchBufferSize

Taille de la mémoire tampon de szDefaultObjectName, dans TCHAR . 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 szDefaultObjectName est trop petite pour contenir le nom de l’objet. Cette valeur de retour est attendue si pcchBufferSize 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 obligatoire 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 terminer la fonction.
PDH_CSTATUS_NO_MACHINE	L’ordinateur spécifié est hors connexion ou indisponible.

Remarques

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

Note

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

PdhGetDefaultPerfCounter

PdhGetDefaultPerfObjectH

Partager via