PdhEnumObjectsHA, fonction (pdh.h)
Retourne une liste d’objets disponibles sur l’ordinateur spécifié ou dans le fichier journal spécifié.
Cette fonction est identique à PdhEnumObjects, sauf qu’elle prend en charge l’utilisation de handles pour les sources de données.
Syntaxe
PDH_FUNCTION PdhEnumObjectsHA(
[in] PDH_HLOG hDataSource,
[in] LPCSTR szMachineName,
[out] PZZSTR mszObjectList,
[in, out] LPDWORD pcchBufferSize,
[in] DWORD dwDetailLevel,
[in] BOOL bRefresh
);
Paramètres
[in] hDataSource
Gérez vers une source de données retournée par la fonction PdhBindInputDataSource .
[in] szMachineName
Chaîne terminée par null qui spécifie le nom de l’ordinateur utilisé pour énumérer les objets de performances.
Incluez les barres obliques de début dans le nom de l’ordinateur, par exemple, \computername.
Si szDataSource a la valeur NULL, vous pouvez définir szMachineName sur NULL pour spécifier l’ordinateur local.
[out] mszObjectList
Mémoire tampon allouée à l’appelant qui reçoit la liste des noms d’objets. Chaque nom d’objet de cette liste est terminé par un caractère Null . La liste se termine par deux caractères de fin null. Définissez sur NULL si pcchBufferLength est égal à zéro.
[in, out] pcchBufferSize
Taille de la mémoire tampon mszObjectList , en TCHAR. Si la valeur est zéro à 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 vous appuyer sur la taille retournée pour réallouer la mémoire tampon.
Windows XP : Ajoutez-en un à la taille de mémoire tampon requise.
[in] dwDetailLevel
Niveau de détail des éléments de performances à retourner. Tous les éléments qui sont du niveau de détail spécifié ou inférieur sont retournés (les niveaux sont répertoriés dans l’ordre croissant). Ce paramètre peut prendre les valeurs suivantes.
[in] bRefresh
Indique si la liste d’objets mis en cache doit être automatiquement actualisée. Spécifiez l’une des valeurs suivantes.
Si vous appelez cette fonction deux fois, une fois pour obtenir la taille de la liste et une deuxième fois pour obtenir la liste réelle, définissez ce paramètre sur TRUE au premier appel et FALSE sur le deuxième appel. Si les deux appels ont la valeur TRUE, le deuxième appel peut également retourner PDH_MORE_DATA, car les données de l’objet ont peut-être changé entre les appels.
| Valeur | Signification |
|---|---|
|
Le cache d’objets est automatiquement actualisé avant que les objets ne soient retournés. |
|
N’actualisez pas automatiquement le cache. |
Valeur retournée
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.
| Code de retour | Description |
|---|---|
|
La mémoire tampon mszObjectList est trop petite pour contenir la liste des objets. Cette valeur de retour est attendue si pcchBufferLength est égal à zéro à 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 vous appuyer sur la taille retournée pour réallouer la mémoire tampon. |
|
L’ordinateur spécifié est hors connexion ou indisponible. |
|
L’objet spécifié est introuvable. |
|
Un paramètre 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. |
Remarques
Vous devez appeler cette fonction deux fois, la première fois pour obtenir la taille de mémoire tampon requise ( définissez mszObjectList sur NULL et pcchBufferLength sur 0) et la deuxième fois pour obtenir les données.
Notes
L’en-tête pdh.h définit PdhEnumObjectsH 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. La combinaison 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 |