structure FAX_CONFIGURATIONA (winfax.h)

Article
03/13/2024

La structure FAX_CONFIGURATION contient des informations sur les paramètres de configuration globaux d’un serveur de télécopie. La structure inclut des données sur 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

typedef struct _FAX_CONFIGURATIONA {
  DWORD    SizeOfStruct;
  DWORD    Retries;
  DWORD    RetryDelay;
  DWORD    DirtyDays;
  BOOL     Branding;
  BOOL     UseDeviceTsid;
  BOOL     ServerCp;
  BOOL     PauseServerQueue;
  FAX_TIME StartCheapTime;
  FAX_TIME StopCheapTime;
  BOOL     ArchiveOutgoingFaxes;
  LPCSTR   ArchiveDirectory;
  LPCSTR   Reserved;
} FAX_CONFIGURATIONA, *PFAX_CONFIGURATIONA;

Membres

SizeOfStruct

Type : DWORD

Spécifie la taille, en octets, de la structure FAX_CONFIGURATION . L’application appelante doit définir ce membre sur sizeof(FAX_CONFIGURATION) avant d’appeler la fonction FaxSetConfiguration .

Retries

Type : DWORD

Spécifie une variable DWORD qui indique le nombre de fois où le serveur de télécopie tente de retransmettre une télécopie sortante si la transmission initiale échoue.

RetryDelay

Type : DWORD

Spécifie une variable DWORD qui indique le nombre de minutes qui s’écouleront entre les tentatives de retransmission par le serveur de télécopie.

DirtyDays

Type : DWORD

Spécifie une variable DWORD qui indique le nombre de jours pendant lesquels le serveur de télécopie conserve un travail non envoyé dans la file d’attente des travaux de télécopie. Une transmission peut ne pas être envoyée, par exemple, si un numéro ou une date de télécopie non valides est spécifié, ou si l’appareil d’envoi reçoit un signal occupé plusieurs fois.

Branding

Type : BOOL

Spécifie une variable booléenne qui indique si le serveur de télécopie doit générer une marque (bannière) en haut des transmissions de télécopie sortantes. Si ce membre a la valeur TRUE, le serveur de télécopie génère une marque qui contient des informations liées à la transmission telles que l’identificateur de la station de transmission, la date, l’heure et le nombre de pages.

UseDeviceTsid

Type : BOOL

Spécifie une variable booléenne qui indique si le serveur de télécopie utilisera l’identificateur de la station de transmission de l’appareil au lieu de la valeur spécifiée dans le membre Tsid de la structure FAX_JOB_PARAM . Si ce membre a la valeur TRUE, le serveur utilise l’identificateur de station de transmission de l’appareil.

ServerCp

Type : BOOL

Spécifie une variable booléenne qui indique si les applications clientes de télécopie peuvent inclure une page de garde conçue par l’utilisateur avec la transmission de télécopie. Si ce membre a la valeur TRUE, le client doit utiliser une page de garde commune stockée sur le serveur de télécopie. Si ce membre a la valeur FALSE, le client peut utiliser un fichier de page de couverture personnel.

PauseServerQueue

Type : BOOL

Spécifie une variable booléenne qui indique si le serveur de télécopie a suspendu la file d’attente des travaux de télécopie. Si ce membre a la valeur TRUE, la file d’attente a été suspendue.

StartCheapTime

Type : FAX_TIME

Spécifie une structure de FAX_TIME qui indique l’heure et la minute auxquelles la période de remise commence. La période de remise s’applique uniquement aux transmissions sortantes.

StopCheapTime

Type : FAX_TIME

Spécifie une structure de FAX_TIME qui indique l’heure et la minute auxquelles la période de remise se termine. La période de remise s’applique uniquement aux transmissions sortantes.

ArchiveOutgoingFaxes

Type : BOOL

Spécifie une variable booléenne qui indique si le serveur de télécopie doit archiver les transmissions de télécopie sortantes. Si ce membre a la valeur TRUE, le serveur archive les transmissions sortantes dans le répertoire spécifié par le membre ArchiveDirectory .

ArchiveDirectory

Type : LPCTSTR

Pointeur vers une chaîne de caractères null constante qui contient le chemin complet du répertoire dans lequel les transmissions de télécopie sortantes seront archivées. Le chemin peut être un chemin UNC ou un chemin commençant par une lettre de lecteur. Le serveur de télécopie ignore ce membre si le membre ArchiveOutgoingFaxes a la valeur FALSE. Ce membre peut avoir la valeur NULL si le membre ArchiveOutgoingFaxes a la valeur FALSE.

Reserved

Remarques

L’application cliente de télécopie transmet la structure FAX_CONFIGURATION dans un appel à la fonction FaxSetConfiguration pour modifier les paramètres de configuration globaux du serveur de télécopie qui vous intéresse. Si l’application appelle la fonction FaxGetConfiguration , elle retourne les paramètres actuels dans une structure FAX_CONFIGURATION . Pour plus d’informations, consultez Gestion de la configuration du serveur de télécopie.

Notes

L’en-tête winfax.h définit FAX_CONFIGURATION 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]
En-tête	winfax.h