PdhEnumLogSetNamesA, fonction (pdh.h)

Article
11/20/2024

Énumère les noms des jeux de journaux dans le DSN.

Syntaxe

PDH_FUNCTION PdhEnumLogSetNamesA(
  [in]      LPCSTR  szDataSource,
  [out]     PZZSTR  mszDataSetNameList,
  [in, out] LPDWORD pcchBufferLength
);

Paramètres

[in] szDataSource

chaîne null-terminated qui spécifie le DSN.

[out] mszDataSetNameList

Mémoire tampon allouée par l’appelant qui reçoit la liste des noms d’ensembles de journaux null-terminated. La liste est terminée avec un caractère null-terminator. Défini sur NULL si le paramètre pcchBufferLength est égal à zéro.

[in, out] pcchBufferLength

Taille de la mémoire tampon mszLogSetNameList, dans TCHARs . 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 taille de la mémoire tampon mszLogSetNameList est trop petite pour contenir toutes les données. Cette valeur de retour est attendue si pcchBufferLength 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 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 mszLogSetNameList sur NULL et pcchBufferLength sur 0) et la deuxième fois pour obtenir les données.

Note

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

Partager via