structure PDH_BROWSE_DLG_CONFIG_W (pdh.h)
La structure PDH_BROWSE_DLG_CONFIG est utilisée par la fonction PdhBrowseCounters pour configurer la boîte de dialogue Parcourir les compteurs de performances .
Syntaxe
typedef struct _BrowseDlgConfig_W {
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;
LPWSTR szDataSource;
LPWSTR szReturnPathBuffer;
DWORD cchReturnPathLength;
CounterPathCallBack pCallBack;
DWORD_PTR dwCallBackArg;
PDH_STATUS CallBackStatus;
DWORD dwDefaultDetailLevel;
LPWSTR szDialogBoxCaption;
} PDH_BROWSE_DLG_CONFIG_W, *PPDH_BROWSE_DLG_CONFIG_W;
Membres
bIncludeInstanceIndex
Si cet indicateur a la valeur TRUE, la boîte de dialogue inclut un numéro d’index pour les noms de instance en double. Par exemple, s’il existe deux instances cmd, la liste instance contient cmd et cmd#1. Si cet indicateur a la valeur FALSE, les noms instance dupliqués ne contiennent pas de numéro d’index.
bSingleCounterPerAdd
Si cet indicateur a la valeur TRUE, la boîte de dialogue ne retourne qu’un seul compteur. Si cet indicateur a la valeur 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 a la valeur 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 a la valeur 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. Vous pouvez cliquer plusieurs fois sur le bouton Ajouter. Le bouton Ajouter remplace les éléments précédemment sélectionnés par les éléments actuellement sélectionnés.
bLocalCountersOnly
Si cet indicateur a la valeur 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 est précédé du chemin du compteur, sauf si l’utilisateur sélectionne Utiliser des compteurs d’ordinateur local.
bWildCardInstances
Si cet indicateur a la valeur TRUE et que l’utilisateur sélectionne Toutes les instances, le chemin du compteur inclut le caractère générique pour le champ instance.
Si cet indicateur a la valeur 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 a la valeur TRUE, cela supprime le 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 fixé à la valeur du membre dwDefaultDetailLevel .
Si cet indicateur a la valeur FALSE, le niveau de détail s’affiche 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 seront ceux dont le niveau de détail est inférieur ou égal à la sélection de niveau de détail actuelle. La sélection d’un niveau de détail de l’Assistant affiche tous les compteurs et objets.
bInitializePath
Si cet indicateur a la valeur 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 affichée pour la première fois, au lieu d’utiliser le compteur et l’objet par défaut spécifiés par l’ordinateur.
Si cet indicateur a la valeur FALSE, cela sélectionne le compteur et l’objet initiaux à l’aide des informations relatives au compteur et à l’objet par défaut retournés par l’ordinateur.
bDisableMachineSelection
Si cet indicateur a la valeur TRUE, l’utilisateur ne peut pas sélectionner un ordinateur dans Sélectionner des compteurs à partir de l’ordinateur.
Si cet indicateur a la valeur 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 pdhConnectMachine pour vous connecter d’abord à d’autres ordinateurs.
bIncludeCostlyObjects
Si cet indicateur a la valeur TRUE, la liste des compteurs contiendra également des données coûteuses, c’est-à-dire des données qui nécessitent une quantité relativement importante de temps processeur ou une surcharge de mémoire à collecter.
Si cet indicateur a la valeur FALSE, la liste ne contiendra pas de compteurs coûteux. Il s’agit de la valeur par défaut.
bShowObjectBrowser
Si cet indicateur a la valeur TRUE, la boîte de dialogue répertorie uniquement les objets de performance. 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 instance et le compteur si l’objet est un objet instance multiple. Par exemple, si l’objet « Process » est sélectionné, la boîte de dialogue retourne la chaîne « \Process(*)* ». Si l’objet est un objet instance unique, le chemin d’accès contient un caractère générique pour compteur uniquement. 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 de la fenêtre pour posséder la boîte de dialogue. Si la valeur est NULL, le propriétaire est le bureau.
szDataSource
Pointeur vers une chaîne terminée par null qui spécifie le nom du fichier journal à partir duquel la liste des compteurs est récupérée. Si la valeur est NULL, la liste des compteurs est récupérée à partir de l’ordinateur local (ou de l’ordinateur distant si spécifié).
szReturnPathBuffer
Pointeur vers un MULTI_SZ qui contient les chemins de compteur sélectionnés.
Si bInitializePath a la valeur 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 les listes d’ordinateur, d’objet, de compteur et de instance lorsque la boîte de dialogue est affichée pour la première fois.
cchReturnPathLength
Taille de la mémoire tampon szReturnPathBuffer , en 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 le status de la mémoire tampon du chemin d’accès. À la sortie, la fonction de rappel définit la valeur status 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 membre szReturnPathBuffer 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 essaie de charger la mémoire tampon avec les chemins sélectionnés et d’appeler à nouveau la fonction de rappel.
Si une autre erreur s’est produite, la fonction de rappel doit retourner la valeur d’erreur PDH appropriée status.
dwDefaultDetailLevel
Niveau de détail par défaut à afficher dans la liste Niveau de détail si bHideDetailBox a la valeur FALSE. Si bHideDetailBox a la valeur 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 :
szDialogBoxCaption
Pointeur vers une chaîne terminée par null qui spécifie le légende facultatif à afficher dans la barre de légende de la boîte de dialogue. Si ce membre a la valeur NULL, le légende sera Parcourir les compteurs de performances.
Remarques
Chaque fois que vous cliquez sur le bouton Ajouter , 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.
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] |
| En-tête | pdh.h |