Share via

FAX_JOB_ENTRYA structure (winfax.h)

  • Article

La structure FAX_JOB_ENTRY décrit un travail de télécopie. La structure inclut des données sur le type de travail et le status, l’identification du destinataire et de l’expéditeur, les paramètres de planification et de remise, ainsi que le nombre de pages. Les membres SizeOfStruct et RecipientNumber sont obligatoires.

Syntaxe

typedef struct _FAX_JOB_ENTRYA {
  DWORD      SizeOfStruct;
  DWORD      JobId;
  LPCSTR     UserName;
  DWORD      JobType;
  DWORD      QueueStatus;
  DWORD      Status;
  DWORD      Size;
  DWORD      PageCount;
  LPCSTR     RecipientNumber;
  LPCSTR     RecipientName;
  LPCSTR     Tsid;
  LPCSTR     SenderName;
  LPCSTR     SenderCompany;
  LPCSTR     SenderDept;
  LPCSTR     BillingCode;
  DWORD      ScheduleAction;
  SYSTEMTIME ScheduleTime;
  DWORD      DeliveryReportType;
  LPCSTR     DeliveryReportAddress;
  LPCSTR     DocumentName;
} FAX_JOB_ENTRYA, *PFAX_JOB_ENTRYA;

Membres

SizeOfStruct

Type : DWORD

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

JobId

Type : DWORD

Spécifie un numéro unique qui identifie le travail de télécopie qui vous intéresse. Ce numéro doit correspondre à la valeur que l’application appelante transmet dans le paramètre JobId à la fonction FaxSetJob .

UserName

Type : LPCTSTR

Pointeur vers une chaîne de caractères constante terminée par null qui spécifie le nom de l’utilisateur qui a envoyé le travail de télécopie.

JobType

Type : DWORD

Spécifie une variable DWORD qui spécifie le type du travail de télécopie qui vous intéresse. Ce membre peut être l’un des types de travaux suivants.

JT_SEND

Le travail est une transmission de télécopie sortante.

JT_RECEIVE

Le travail est une transmission de télécopie entrante.

JT_UNKNOWN

Le type de travail est inconnu. Cette valeur indique que le serveur de télécopie n’a pas encore planifié le travail.

JT_ROUTING

Le serveur de télécopie a tenté d’acheminer la transmission de télécopie, mais le routage a échoué. Le serveur de télécopie tente à nouveau d’acheminer le travail.

JT_FAIL_RECEIVE

Le serveur de télécopie n’a pas acheminé la télécopie, car il n’a pas reçu la transmission entière. Le serveur de télécopie enregistre la transmission partielle dans un répertoire temporaire.

QueueStatus

Type : DWORD

Spécifie une variable DWORD qui est un ensemble d’indicateurs de bits indiquant la file d’attente status du travail de télécopie identifié par le membre JobId. Ce membre peut être une ou plusieurs des valeurs suivantes.

JS_PENDING

Le travail de télécopie se trouve dans la file d’attente et le service en attente.

JS_INPROGRESS

Le travail de télécopie est en cours.

JS_DELETING

Le serveur de télécopie supprime le travail de télécopie.

JS_FAILED

Échec du travail de télécopie.

JS_PAUSED

Le serveur de télécopie a suspendu le travail de télécopie.

JS_NOLINE

Aucune ligne n’est disponible pour envoyer la télécopie. Le serveur de télécopie envoie la transmission lorsqu’une ligne est disponible.

JS_RETRYING

Échec du travail de télécopie. Le serveur de télécopie tente de retransmettre la télécopie après un intervalle spécifié. Pour plus d’informations sur les paramètres de configuration globaux, tels que les intervalles de retransmission, consultez FAX_CONFIGURATION.

JS_RETRIES_EXCEEDED

Le serveur de télécopie a dépassé le nombre maximal de tentatives de retransmission autorisées. La télécopie ne sera pas envoyée. Pour plus d’informations sur les paramètres de configuration globaux, tels que le nombre maximal de tentatives de retransmission, consultez FAX_CONFIGURATION.

Status

Type : DWORD

Spécifie une variable DWORD qui est un périphérique de télécopie status code ou valeur. Cette valeur peut être l’un des codes de status d’appareil prédéfinis suivants.

FPS_DIALING

L’appareil compose un numéro de télécopie.

FPS_SENDING

L’appareil envoie un document de télécopie.

FPS_RECEIVING

L’appareil reçoit un document de télécopie.

FPS_COMPLETED

L’appareil a terminé l’envoi ou la réception d’une transmission par télécopie.

FPS_UNAVAILABLE

L’appareil n’est pas disponible, car il est utilisé par une autre application.

FPS_BUSY

L’appareil a rencontré un signal d’activité.

FPS_NO_ANSWER

L’appareil de réception n’a pas répondu à l’appel.

FPS_BAD_ADDRESS

L’appareil a composé un numéro de télécopie non valide.

FPS_NO_DIAL_TONE

L’appareil d’envoi ne peut pas terminer l’appel, car il ne détecte pas de tonalité.

FPS_DISCONNECTED

L’appel de télécopie a été déconnecté par l’expéditeur ou l’appelant.

FPS_FATAL_ERROR

L’appareil a rencontré une erreur de protocole irrécupérable.

FPS_NOT_FAX_CALL

L’appareil a reçu un appel qui était un appel de données ou un appel vocal.

FPS_CALL_DELAYED

L’appareil a retardé un appel de télécopie, car l’appareil d’envoi a reçu un signal d’occupation plusieurs fois. L’appareil ne peut pas retenter l’appel, car il existe des restrictions de numérotation. (Certains pays/régions limitent le nombre de nouvelles tentatives lorsqu’un nombre est occupé.)

FPS_CALL_BLACKLISTED

L’appareil n’a pas pu effectuer un appel, car le numéro de téléphone a été bloqué ou réservé ; les numéros d’urgence tels que le 911 sont bloqués.

FPS_INITIALIZING

L’appareil initialise un appel.

FPS_OFFLINE

L’appareil est hors connexion et non disponible.

FPS_RINGING

L’appareil sonne.

FPS_AVAILABLE

L’appareil est disponible.

FPS_ABORTING

L’appareil abandonne un travail de télécopie.

FPS_ROUTING

L’appareil achemine un document de télécopie reçu.

FPS_ANSWERED

L’appareil a répondu à un nouvel appel.

FPS_HANDLED

Le service de télécopie a traité le document de télécopie sortant ; le fournisseur de services de télécopie transmet le document.

Size

Type : DWORD

Spécifie une variable DWORD qui contient la taille, en octets, du document de télécopie à transmettre. La taille ne doit pas dépasser 4 Go.

PageCount

Type : DWORD

Spécifie une variable DWORD qui indique le nombre total de pages dans la transmission de télécopie.

RecipientNumber

Type : LPCTSTR

Pointeur vers une chaîne de caractères null constante qui spécifie le numéro de télécopie du destinataire de la transmission de télécopie.

RecipientName

Type : LPCTSTR

Pointeur vers une chaîne de caractères null constante qui spécifie le nom du destinataire de la transmission de télécopie.

Tsid

Type : LPCTSTR

Pointeur vers une chaîne de caractères null constante qui spécifie l’identificateur de la station de transmission. Cet identificateur est généralement un numéro de téléphone.

SenderName

Type : LPCTSTR

Pointeur vers une chaîne de caractères null constante qui spécifie le nom de l’expéditeur qui a lancé la transmission de télécopie.

SenderCompany

Type : LPCTSTR

Pointeur vers une chaîne de caractères null constante qui spécifie le nom de l’entreprise de l’expéditeur qui a lancé la transmission de télécopie.

SenderDept

Type : LPCTSTR

Pointeur vers une chaîne de caractères null constante qui spécifie le nom du service de l’expéditeur qui a lancé la transmission de télécopie.

BillingCode

Type : LPCTSTR

Pointeur vers une chaîne de caractères null constante qui indique un code de facturation spécifique à l’application ou au serveur qui s’applique à la transmission de télécopie. Le serveur de télécopie utilise la chaîne pour générer une entrée dans le journal des événements de télécopie. Les codes de facturation sont facultatifs.

ScheduleAction

Type : DWORD

Spécifie une variable DWORD qui indique quand envoyer la télécopie. Ce membre peut être l’une des actions de planification de travail prédéfinies suivantes.

JSA_NOW

Envoyez la télécopie dès qu’un appareil est disponible.

JSA_SPECIFIC_TIME

Envoyez la télécopie à l’heure spécifiée par le membre ScheduleTime .

JSA_DISCOUNT_PERIOD

Envoyez la télécopie pendant la période de taux d’actualisation. Appelez la fonction FaxGetConfiguration pour récupérer la période de remise du serveur de télécopie.

ScheduleTime

Type : SYSTEMTIME

Si le membre ScheduleAction est égal à la valeur JSA_SPECIFIC_TIME, spécifie une structure SYSTEMTIME qui contient la date et l’heure d’envoi de la télécopie. L’heure spécifiée doit être exprimée en UTC.

DeliveryReportType

Type : DWORD

Spécifie une variable DWORD qui indique le type de rapport de remise d’e-mails (DR) ou de rapport de non-remise (NDR) que le serveur de télécopie doit générer. Ce membre peut être l’un des types de rapports de remise prédéfinis suivants.

DRT_NONE

N’envoyez pas de récupération d’urgence ou de remise de remise à l’expéditeur de la transmission de télécopie.

DRT_EMAIL

Envoyez la récupération d’urgence ou NDR dans un e-mail à l’expéditeur de la transmission de télécopie (pris en charge dans Windows Server 2003 et versions ultérieures).

DRT_INBOX

Envoyez la récupération d’urgence ou la remise d’échec dans un e-mail au magasin de dossiers personnels (PST) local de l’expéditeur.

DeliveryReportAddress

Type : LPCTSTR

Pointeur vers une chaîne de caractères null constante. Si le membre DeliveryReportType est égal à DRT_EMAIL, la chaîne est l’adresse à laquelle la récupération d’urgence ou la remise en état doit être envoyée. Si le membre DeliveryReportType est égal à DRT_NONE, ce membre doit avoir la valeur NULL.

DocumentName

Type : LPCTSTR

Pointeur vers une chaîne de caractères null constante à associer au document de télécopie. Il s’agit du nom convivial qui apparaît dans le spouleur d’impression.

Remarques

Une application cliente de télécopie transmet la structure FAX_JOB_ENTRY dans un appel à la fonction FaxSetJob .

Une application peut appeler la fonction FaxEnumJobs pour énumérer tous les travaux de télécopie en file d’attente et actifs sur le serveur de télécopie concerné. FaxEnumJobs retourne un tableau de structures FAX_JOB_ENTRY . Chaque structure décrit un travail de télécopie en détail.

Pour plus d’informations, consultez Gestion des travaux de télécopie.

Notes

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

Voir aussi

FAX_CONFIGURATION

Structures de l’API cliente du service de télécopie

API cliente de service de télécopie pour Windows 2000

FaxEnumJobs

FaxSetJob

SYSTEMTIME