Fonction FaxGetConfigurationA (winfax.h)

Article
03/09/2024

La fonction FaxGetConfiguration renvoie à une application cliente de télécopie les paramètres de configuration globaux du serveur de télécopie auquel le client s’est connecté. Les données incluent, entre autres éléments, les paramètres de retransmission, de personnalisation, d’archivage et de page de couverture ; périodes de taux d’actualisation ; et la status de la file d’attente du serveur de télécopie.

Syntaxe

WINFAXAPI BOOL FaxGetConfigurationA(
  [in]  HANDLE              FaxHandle,
  [out] PFAX_CONFIGURATIONA *FaxConfig
);

Paramètres

[in] FaxHandle

Type : HANDLE

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

[out] FaxConfig

Type : PFAX_CONFIGURATION*

Pointeur vers l’adresse d’une mémoire tampon pour recevoir une structure FAX_CONFIGURATION . La structure contient les paramètres de configuration actuels du serveur de télécopie. Pour plus d’informations sur l’allocation de mémoire, consultez la section Remarques suivante.

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_INVALID_PARAMETER	L’un ou les deux paramètres FaxConfig ou FaxHandle sont NULL.
ERROR_ACCESS_DENIED	L’accès est refusé. FAX_CONFIG_QUERY accès est requis.
ERROR_NOT_ENOUGH_MEMORY	Une erreur s’est produite lors de l’allocation de mémoire.

Remarques

Une application d’administration de télécopie appelle généralement la fonction FaxGetConfiguration pour afficher les paramètres de configuration globaux du serveur de télécopie. Pour modifier les paramètres de configuration, appelez la fonction FaxSetConfiguration .

La fonction FaxGetConfiguration alloue la mémoire nécessaire pour la mémoire tampon FAX_CONFIGURATION pointée par le paramètre FaxConfig . Une application doit appeler la fonction FaxFreeBuffer pour libérer les ressources associées à ce paramètre.

Pour plus d’informations, consultez Gestion de la configuration du serveur de télécopie et Libération des ressources de télécopie.

Notes

L’en-tête winfax.h définit FaxGetConfiguration comme un 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.

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