Partager via


structure PDH_BROWSE_DLG_CONFIG_HA (pdh.h)

La structure PDH_BROWSE_DLG_CONFIG_H est utilisée par la fonction PdhBrowseCountersH pour configurer la boîte de dialogue Parcourir les compteurs de performances.

Syntaxe

typedef struct _BrowseDlgConfig_HA {
  DWORD               bIncludeInstanceIndex : 1;
  DWORD               bSingleCounterPerAdd : 1;
  DWORD               bSingleCounterPerDialog : 1;
  DWORD               bLocalCountersOnly : 1;
  DWORD               bWildCardInstances : 1;
  DWORD               bHideDetailBox : 1;
  DWORD               bInitializePath : 1;
  DWORD               bDisableMachineSelection : 1;
  DWORD               bIncludeCostlyObjects : 1;
  DWORD               bShowObjectBrowser : 1;
  DWORD               bReserved : 22;
  HWND                hWndOwner;
  PDH_HLOG            hDataSource;
  LPSTR               szReturnPathBuffer;
  DWORD               cchReturnPathLength;
  CounterPathCallBack pCallBack;
  DWORD_PTR           dwCallBackArg;
  PDH_STATUS          CallBackStatus;
  DWORD               dwDefaultDetailLevel;
  LPSTR               szDialogBoxCaption;
} PDH_BROWSE_DLG_CONFIG_HA, *PPDH_BROWSE_DLG_CONFIG_HA;

Membres

bIncludeInstanceIndex

Si cet indicateur est TRUE, la boîte de dialogue inclut un numéro d’index pour les noms d’instances dupliqués. Par exemple, s’il existe deux instances cmd, la liste d’instances contient cmd et cmd#1. Si cet indicateur est FALSE, les noms d’instances en double ne contiennent pas de numéro d’index.

bSingleCounterPerAdd

Si cet indicateur est TRUE, la boîte de dialogue ne retourne qu’un seul compteur. Si cet indicateur est FALSE, la boîte de dialogue peut retourner plusieurs sélections et les sélections génériques sont autorisées. Les compteurs sélectionnés sont retournés sous forme de chaîne MULTI_SZ.

bSingleCounterPerDialog

Si cet indicateur est TRUE, la boîte de dialogue utilise un bouton OK et Annuler. La boîte de dialogue retourne lorsque l’utilisateur clique sur l’un ou l’autre bouton. Si cet indicateur est FALSE, la boîte de dialogue utilise un bouton Ajouter et fermer. La boîte de dialogue se ferme lorsque l’utilisateur clique sur le bouton Fermer. Le bouton Ajouter peut être cliqué plusieurs fois. Le bouton Ajouter remplace les éléments sélectionnés précédemment avec les éléments actuellement sélectionnés.

bLocalCountersOnly

Si cet indicateur est TRUE, la boîte de dialogue permet à l’utilisateur de sélectionner des compteurs uniquement à partir de l’ordinateur local (le chemin d’accès ne contient pas de nom d’ordinateur). Si cet indicateur est FALSE, l’utilisateur peut spécifier un ordinateur à partir duquel sélectionner des compteurs. Le nom de l’ordinateur préfixe le chemin du compteur, sauf si l’utilisateur sélectionne Utiliser des compteurs d’ordinateur local.

bWildCardInstances

Si cet indicateur est TRUE et que l’utilisateur sélectionne Toutes les instances, le chemin du compteur inclut le caractère générique du champ d’instance.

Si cet indicateur est FALSE, et que l’utilisateur sélectionne Toutes les instances, toutes les instances actuellement trouvées pour cet objet sont retournées dans une chaîne MULTI_SZ.

bHideDetailBox

Si cet indicateur est TRUE, cela supprime niveau de détail de la boîte de dialogue afin que l’utilisateur ne puisse pas modifier le niveau de détail des compteurs affichés dans la boîte de dialogue. Le niveau de détail est fixe à la valeur du membre dwDefaultDetailLevel.

Si cet indicateur est FAUX, il affiche niveau de détail dans la boîte de dialogue, ce qui permet à l’utilisateur de modifier le niveau de détail des compteurs affichés.

Notez que les compteurs affichés sont ceux dont le niveau de détail est inférieur ou égal à la sélection de niveau de détail actuel. La sélection d’un niveau de détail de l’Assistant affiche tous les compteurs et tous les objets.

bInitializePath

Si cet indicateur est TRUE, la boîte de dialogue met en surbrillance le compteur et l’objet spécifiés dans szReturnPathBuffer lorsque la boîte de dialogue est d’abord affichée, au lieu d’utiliser le compteur et l’objet par défaut spécifiés par l’ordinateur.

Si cet indicateur est FALSE, il sélectionne le compteur initial et l’objet à l’aide du compteur par défaut et des informations d’objet retournées par l’ordinateur.

bDisableMachineSelection

Si cet indicateur est TRUE, l’utilisateur ne peut pas sélectionner un ordinateur dans Sélectionner des compteurs à partir de l’ordinateur.

Si cet indicateur est FALSE, l’utilisateur peut sélectionner un ordinateur dans Sélectionner des compteurs à partir de l’ordinateur. Il s’agit de la valeur par défaut. La liste contient l’ordinateur local uniquement, sauf si vous appelez d’abord le PdhConnectMachine pour vous connecter à d’autres ordinateurs.

bIncludeCostlyObjects

Si cet indicateur est TRUE, la liste des compteurs contient également des données coûteuses, c’est-à-dire des données qui nécessitent une quantité relativement importante de temps processeur ou de surcharge de mémoire à collecter.

Si cet indicateur est FALSE, la liste ne contient pas de compteurs coûteux. Il s’agit de la valeur par défaut.

bShowObjectBrowser

Si cet indicateur est TRUE, la boîte de dialogue répertorie uniquement les objets de performances. Lorsque l’utilisateur sélectionne un objet, la boîte de dialogue retourne un chemin d’accès de compteur qui inclut l’objet et les caractères génériques pour le nom et le compteur de l’instance si l’objet est un objet d’instance multiple. Par exemple, si l’objet « Process » est sélectionné, la boîte de dialogue renvoie la chaîne « \Process(*)* ». Si l’objet est un objet d’instance unique, le chemin d’accès contient un caractère générique uniquement pour le compteur. Par exemple, « \System* ». Vous pouvez ensuite passer le chemin d’accès à PdhExpandWildCardPath pour récupérer une liste de chemins d’accès réels pour l’objet.

bReserved

hWndOwner

Handle of the window to own the dialog. Si NULL, le propriétaire est le bureau.

hDataSource

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

szReturnPathBuffer

Pointeur vers un MULTI_SZ qui contient les chemins de compteur sélectionnés.

Si bInitializePath est TRUE, vous pouvez utiliser ce membre pour spécifier un chemin d’accès de compteur dont les composants sont utilisés pour mettre en surbrillance les entrées dans l’ordinateur, l’objet, le compteur et les listes d’instances lorsque la boîte de dialogue s’affiche pour la première fois.

cchReturnPathLength

Taille de la mémoire tampon de szReturnPathBuffer, dans TCHAR. Si la fonction de rappel réalloue une nouvelle mémoire tampon, elle doit également mettre à jour cette valeur.

pCallBack

Pointeur vers la fonction de rappel qui traite la sélection de l’utilisateur. Pour plus d’informations, consultez CounterPathCallBack.

dwCallBackArg

Valeur définie par l’appelant qui est passée à la fonction de rappel.

CallBackStatus

Lors de l’entrée à la fonction de rappel, ce membre contient l’état de la mémoire tampon du chemin d’accès. À la sortie, la fonction de rappel définit la valeur d’état résultant du traitement.

Si la mémoire tampon est trop petite pour charger la sélection actuelle, la boîte de dialogue définit cette valeur sur PDH_MORE_DATA. Si cette valeur est ERROR_SUCCESS, le szReturnPathBuffer membre contient un chemin d’accès de compteur ou une liste de chemins de compteur valide.

Si la fonction de rappel réalloue une nouvelle mémoire tampon, elle doit définir ce membre sur PDH_RETRY afin que la boîte de dialogue tente de charger la mémoire tampon avec les chemins sélectionnés et de rappeler la fonction de rappel.

Si une autre erreur s’est produite, la fonction de rappel doit retourner la valeur d’état d’erreur PDH appropriée.

dwDefaultDetailLevel

Niveau de détail par défaut à afficher dans la liste niveau de détail si bHideDetailBox est FALSE. Si bHideDetailBox est TRUE, la boîte de dialogue utilise cette valeur pour filtrer les compteurs de performances et les objets affichés. Vous pouvez spécifier l’une des valeurs suivantes :

Niveau de détail Signification
PERF_DETAIL_NOVICE
Un utilisateur novice peut comprendre les données du compteur.
PERF_DETAIL_ADVANCED
Les données de compteur sont fournies pour les utilisateurs avancés.
PERF_DETAIL_EXPERT
Les données de compteur sont fournies pour les utilisateurs experts.
PERF_DETAIL_WIZARD
Les données de compteur sont fournies pour les concepteurs système.

szDialogBoxCaption

Pointeur vers une chaîne null-terminated qui spécifie la légende facultative à afficher dans la barre de légende de la boîte de dialogue. Si ce membre est NULL, la légende est Parcourir les compteurs de performances.

Remarques

Chaque fois que le bouton Ajouter est cliqué, la mémoire tampon szReturnPathBuffer contient le compteur sélectionné et la fonction de rappel pCallBack est appelée. La fonction de rappel doit appeler la fonction PdhAddCounter pour chaque compteur dans la mémoire tampon.

Note

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

Voir aussi

CounterPathCallBack

PdhAddCounter

PdhBindInputDataSource

PdhBrowseCountersH