PdhGetDefaultPerfObjectHA, fonction (pdh.h)

  • Article

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.

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

Syntaxe

PDH_FUNCTION PdhGetDefaultPerfObjectHA(
  [in]      PDH_HLOG hDataSource,
  [in]      LPCSTR   szMachineName,
  [out]     LPSTR    szDefaultObjectName,
  [in, out] LPDWORD  pcchBufferSize
);

Paramètres

[in] hDataSource

Doit avoir la valeur NULL.

Si vous spécifiez un handle de fichier journal, szDefaultObjectName est une chaîne null .

[in] szMachineName

Chaîne terminée par null qui spécifie le nom de l’ordinateur utilisé pour vérifier le nom de l’objet. Si la valeur est NULL, l’ordinateur local est utilisé pour vérifier le nom.

[out] szDefaultObjectName

Mémoire tampon allouée à l’appelant qui reçoit le nom de l’objet par défaut terminé par null. Définissez la valeur NULL si pcchBufferSize est égal à zéro.

Notez que PDH retourne toujours Processeur pour le nom de l’objet par défaut.

[in, out] pcchBufferSize

Taille de la mémoire tampon szDefaultObjectName , en TCHAR. Si zéro lors de 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 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. Voici les valeurs possibles.

Code de retour 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 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 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.
PDH_CSTATUS_NO_COUNTERNAME
 Impossible de lire ou de trouver le nom de l’objet par défaut.

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.

Notes

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

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

PdhBindInputDataSource

PdhBrowseCountersH

PdhGetDefaultPerfCounterH