FaxGetLoggingCategoriesA, fonction (winfax.h)

Article
08/27/2023

La fonction FaxGetLoggingCategories retourne à une application cliente de télécopie les catégories de journalisation actuelles pour le serveur de télécopie auquel le client s’est connecté. Une catégorie de journalisation détermine les erreurs ou autres événements enregistrés par le serveur de télécopie dans le journal des événements de l’application.

Syntaxe

WINFAXAPI BOOL FaxGetLoggingCategoriesA(
  [in]  HANDLE             FaxHandle,
  [out] PFAX_LOG_CATEGORYA *Categories,
  [out] LPDWORD            NumberCategories
);

Paramètres

[in] FaxHandle

Type : HANDLE

Spécifie un handle de serveur de télécopie retourné par un appel à la fonction FaxConnectFaxServer .

[out] Categories

Type : PFAX_LOG_CATEGORY*

Pointeur vers l’adresse d’une mémoire tampon pour recevoir un tableau de structures FAX_LOG_CATEGORY . Chaque structure décrit une catégorie de journalisation actuelle. Les données incluent le nom descriptif de la catégorie de journalisation, le numéro de catégorie et le niveau de journalisation actuel.

Pour obtenir une description des catégories de journalisation et des niveaux de journalisation prédéfinis, consultez la rubrique FAX_LOG_CATEGORY . Pour plus d’informations sur l’allocation de mémoire, consultez la section Remarques suivante.

[out] NumberCategories

Type : LPDWORD

Pointeur vers une variable DWORD pour recevoir le nombre de structures FAX_LOG_CATEGORY que la fonction retourne dans le paramètre Categories .

Valeur retournée

Type : BOOL

Si la fonction réussit, la valeur de retour est différente de zéro.

Si la fonction échoue, la valeur de retour est égale à zéro. Pour obtenir des informations détaillées sur l’erreur, appelez GetLastError. GetLastError peut retourner l’une des erreurs suivantes.

Code de retour	Description
ERROR_ACCESS_DENIED	L’accès est refusé. FAX_CONFIG_QUERY accès est requis.
ERROR_INVALID_PARAMETER	Un ou tous les paramètres Categories, NumberCategories ou FaxHandle sont NULL.
ERROR_NOT_ENOUGH_MEMORY	Une erreur s’est produite lors de l’allocation de mémoire.

Remarques

Une application cliente de télécopie appelle généralement la fonction FaxGetLoggingCategories pour interroger les catégories de journalisation et les niveaux de journalisation actuels d’un serveur de télécopie. Pour modifier les catégories et niveaux de journalisation actuels, appelez la fonction FaxSetLoggingCategories .

La fonction FaxGetLoggingCategories alloue la mémoire requise pour le tableau de mémoires tampons FAX_LOG_CATEGORY pointé par le paramètre Categories . Une application doit appeler la fonction FaxFreeBuffer pour libérer les ressources associées à ce paramètre.

Pour plus d’informations, consultez Gestion des catégories de journalisation et Libération des ressources de télécopie.

Notes

L’en-tête winfax.h définit FaxGetLoggingCategories 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 2000 Professionnel [applications de bureau uniquement]
Serveur minimal pris en charge	Windows 2000 Server [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	winfax.h
Bibliothèque	WinFax.lib