FAX_JOB_ENTRYA-Struktur (winfax.h)
Die FAX_JOB_ENTRY-Struktur beschreibt einen Faxauftrag. Die Struktur enthält Daten zum Auftragstyp und status, Empfänger- und Absenderidentifikation, Planungs- und Übermittlungseinstellungen sowie die Seitenanzahl. Die Member SizeOfStruct und RecipientNumber sind erforderlich.
Syntax
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;
Member
SizeOfStruct
Art: DWORD
Gibt die Größe der FAX_JOB_ENTRY-Struktur in Bytes an. Die aufrufende Anwendung muss diesen Member auf sizeof(FAX_JOB_ENTRY) festlegen, bevor die FaxSetJob-Funktion aufgerufen wird.
JobId
Art: DWORD
Gibt eine eindeutige Zahl an, die den relevanten Faxauftrag identifiziert. Diese Zahl muss mit dem Wert übereinstimmen, den die aufrufende Anwendung im JobId-Parameter an die FaxSetJob-Funktion übergibt.
UserName
Typ: LPCTSTR
Zeiger auf eine konstante NULL-endende Zeichenfolge, die den Namen des Benutzers angibt, der den Faxauftrag übermittelt hat.
JobType
Art: DWORD
Gibt eine DWORD-Variable an, die den Typ des relevanten Faxauftrags angibt. Dieser Member kann einer der folgenden Auftragstypen sein.
JT_SEND
Der Auftrag ist eine ausgehende Faxübertragung.
JT_RECEIVE
Der Auftrag ist eine eingehende Faxübertragung.
JT_UNKNOWN
Der Auftragstyp ist unbekannt. Dieser Wert gibt an, dass der Faxserver den Auftrag noch nicht geplant hat.
JT_ROUTING
Der Faxserver hat versucht, die Faxübertragung weiterzuleiten, aber das Routing ist fehlgeschlagen. Der Faxserver versucht erneut, den Auftrag weiterzuleiten.
JT_FAIL_RECEIVE
Der Faxserver hat das Fax nicht weitergeleitet, da er nicht die gesamte Übertragung empfangen hat. Der Faxserver speichert die Teilübertragung in einem temporären Verzeichnis.
QueueStatus
Art: DWORD
Gibt eine DWORD-Variable an, bei der es sich um einen Satz von Bitflags handelt, die die Warteschlange status des Faxauftrags angeben, der vom JobId-Element identifiziert wird. Bei diesem Member kann es sich um einen oder mehrere der folgenden Werte handeln.
JS_PENDING
Der Faxauftrag befindet sich in der Warteschlange und im ausstehenden Dienst.
JS_INPROGRESS
Der Faxauftrag wird ausgeführt.
JS_DELETING
Der Faxserver löscht den Faxauftrag.
JS_FAILED
Fehler beim Faxauftrag.
JS_PAUSED
Der Faxserver hat den Faxauftrag angehalten.
JS_NOLINE
Es ist keine Leitung verfügbar, um das Fax zu senden. Der Faxserver sendet die Übertragung, wenn eine Leitung verfügbar ist.
JS_RETRYING
Fehler beim Faxauftrag. Der Faxserver versucht, das Fax nach einem angegebenen Intervall erneut zu übertragen. Weitere Informationen zu globalen Konfigurationseinstellungen, z. B. Neuübertragungsintervallen, finden Sie unter FAX_CONFIGURATION.
JS_RETRIES_EXCEEDED
Der Faxserver hat die maximal zulässige Anzahl von Wiederholungsversuchen überschritten. Das Fax wird nicht gesendet. Weitere Informationen zu globalen Konfigurationseinstellungen, z. B. die maximale Anzahl von Wiederholungsversuchen, finden Sie unter FAX_CONFIGURATION.
Status
Art: DWORD
Gibt eine DWORD-Variable an, die ein Faxgerät status Code oder Wert ist. Dieser Wert kann einer der folgenden vordefinierten Gerätecodes status sein.
FPS_DIALING
Das Gerät wählt eine Faxnummer.
FPS_SENDING
Das Gerät sendet ein Faxdokument.
FPS_RECEIVING
Das Gerät empfängt ein Faxdokument.
FPS_COMPLETED
Das Gerät hat das Senden oder Empfangen einer Faxübertragung abgeschlossen.
FPS_UNAVAILABLE
Das Gerät ist nicht verfügbar, da es von einer anderen Anwendung verwendet wird.
FPS_BUSY
Das Gerät ist auf ein Ausgelastungssignal gestoßen.
FPS_NO_ANSWER
Das empfangende Gerät nahm den Anruf nicht an.
FPS_BAD_ADDRESS
Das Gerät wählte eine ungültige Faxnummer.
FPS_NO_DIAL_TONE
Das sendende Gerät kann den Anruf nicht abschließen, da es keinen Wählton erkennt.
FPS_DISCONNECTED
Der Faxanruf wurde vom Absender oder anrufer getrennt.
FPS_FATAL_ERROR
Auf dem Gerät ist ein schwerwiegender Protokollfehler aufgetreten.
FPS_NOT_FAX_CALL
Das Gerät hat einen Anruf empfangen, bei dem es sich um einen Datenanruf oder einen Sprachanruf handelte.
FPS_CALL_DELAYED
Das Gerät verzögerte einen Faxanruf, weil das sendenden Gerät mehrmals ein Ausgelastungssignal empfangen hat. Das Gerät kann den Anruf nicht wiederholen, da Wählbeschränkungen bestehen. (Einige Länder/Regionen beschränken die Anzahl von Wiederholungsversuchen, wenn eine Zahl ausgelastet ist.)
FPS_CALL_BLACKLISTED
Das Gerät konnte einen Anruf nicht abschließen, weil die Telefonnummer blockiert oder reserviert war; Notrufnummern wie 911 sind blockiert.
FPS_INITIALIZING
Das Gerät initialisiert einen Anruf.
FPS_OFFLINE
Das Gerät ist offline und nicht verfügbar.
FPS_RINGING
Das Gerät klingelt.
FPS_AVAILABLE
Das Gerät ist verfügbar.
FPS_ABORTING
Das Gerät bricht einen Faxauftrag ab.
FPS_ROUTING
Das Gerät routingt ein empfangenes Faxdokument.
FPS_ANSWERED
Das Gerät hat einen neuen Anruf angenommen.
FPS_HANDLED
Der Faxdienst verarbeitete das ausgehende Faxdokument. der Faxdienstanbieter übermittelt das Dokument.
Size
Art: DWORD
Gibt eine DWORD-Variable an, die die Größe des zu übertragenden Faxdokuments in Bytes enthält. Die Größe darf 4 GB nicht überschreiten.
PageCount
Art: DWORD
Gibt eine DWORD-Variable an, die die Gesamtzahl der Seiten in der Faxübertragung angibt.
RecipientNumber
Typ: LPCTSTR
Zeiger auf eine konstante NULL-endende Zeichenfolge, die die Faxnummer des Empfängers der Faxübertragung angibt.
RecipientName
Typ: LPCTSTR
Zeiger auf eine konstante NULL-endende Zeichenfolge, die den Namen des Empfängers der Faxübertragung angibt.
Tsid
Typ: LPCTSTR
Zeiger auf eine konstante NULL-endende Zeichenfolge, die den Bezeichner der Sendestation angibt. Dieser Bezeichner ist in der Regel eine Telefonnummer.
SenderName
Typ: LPCTSTR
Zeiger auf eine konstante NULL-endende Zeichenfolge, die den Namen des Absenders angibt, der die Faxübertragung initiiert hat.
SenderCompany
Typ: LPCTSTR
Zeiger auf eine konstante NULL-endende Zeichenfolge, die den Firmennamen des Absenders angibt, der die Faxübertragung initiiert hat.
SenderDept
Typ: LPCTSTR
Zeiger auf eine konstante NULL-endende Zeichenfolge, die den Abteilungsnamen des Absenders angibt, der die Faxübertragung initiiert hat.
BillingCode
Typ: LPCTSTR
Zeiger auf eine konstante NULL-endende Zeichenfolge, die einen anwendungs- oder serverspezifischen Abrechnungscode angibt, der für die Faxübertragung gilt. Der Faxserver verwendet die Zeichenfolge, um einen Eintrag im Faxereignisprotokoll zu generieren. Abrechnungscodes sind optional.
ScheduleAction
Art: DWORD
Gibt eine DWORD-Variable an, die angibt, wann das Fax gesendet werden soll. Bei diesem Member kann es sich um eine der folgenden vordefinierten Aufgabenplanungsaktionen handeln.
JSA_NOW
Senden Sie das Fax, sobald ein Gerät verfügbar ist.
JSA_SPECIFIC_TIME
Senden Sie das Fax zu der vom ScheduleTime-Element angegebenen Zeit.
JSA_DISCOUNT_PERIOD
Senden Sie das Fax während des Rabattzeitraums. Rufen Sie die FaxGetConfiguration-Funktion auf, um den Rabattzeitraum für den Faxserver abzurufen.
ScheduleTime
Typ: SYSTEMTIME
Wenn das ScheduleAction-Element gleich dem Wert JSA_SPECIFIC_TIME ist, gibt eine SYSTEMTIME-Struktur an, die das Datum und die Uhrzeit für das Senden des Faxs enthält. Die angegebene Zeit muss in UTC ausgedrückt werden.
DeliveryReportType
Art: DWORD
Gibt eine DWORD-Variable an, die den Typ des E-Mail-Übermittlungsberichts (Dr) oder des nicht verwertigen Berichts (Non-Delivery Report, NDR) angibt, den der Faxserver generieren soll. Dieser Member kann einer der folgenden vordefinierten Übermittlungsberichtstypen sein.
DRT_NONE
Senden Sie keine Notfallwiederherstellung oder einen NDR an den Absender der Faxübertragung.
DRT_EMAIL
Senden Sie die Notfallwiederherstellung oder den NDR in einer E-Mail-Nachricht an den Absender der Faxübertragung (unterstützt in Windows Server 2003 und höher).
DRT_INBOX
Senden Sie die Notfallwiederherstellung oder den NDR per E-Mail an den lokalen persönlichen Ordnerspeicher (PST) des Absenders.
DeliveryReportAddress
Typ: LPCTSTR
Zeiger auf eine konstante NULL-endende Zeichenfolge. Wenn das DeliveryReportType-Elementgleich DRT_EMAIL ist, ist die Zeichenfolge die Adresse, an die die Notfallwiederherstellung oder der NDR gesendet werden soll. Wenn das DeliveryReportType-Elementgleich DRT_NONE ist, muss dieser Member NULL sein.
DocumentName
Typ: LPCTSTR
Zeiger auf eine konstante NULL-endende Zeichenfolge, die dem Faxdokument zugeordnet werden soll. Dies ist der benutzerfreundliche Name, der im Druckspooler angezeigt wird.
Hinweise
Eine Faxclientanwendung übergibt die FAX_JOB_ENTRY-Struktur in einem Aufruf der FaxSetJob-Funktion .
Eine Anwendung kann die FaxEnumJobs-Funktion aufrufen, um alle in der Warteschlange befindlichen und aktiven Faxaufträge auf dem relevanten Faxserver aufzulisten. FaxEnumJobs gibt ein Array von FAX_JOB_ENTRY-Strukturen zurück. Jede Struktur beschreibt einen Faxauftrag im Detail.
Weitere Informationen finden Sie unter Verwalten von Faxaufträgen.
Hinweis
Der winfax.h-Header definiert FAX_JOB_ENTRY als Alias, der die ANSI- oder Unicode-Version dieser Funktion basierend auf der Definition der UNICODE-Präprozessorkonstante automatisch auswählt. Das Mischen der Verwendung des codierungsneutralen Alias mit Code, der nicht Codierungsneutral ist, kann zu Nichtübereinstimmungen führen, die zu Kompilierungs- oder Laufzeitfehlern führen. Weitere Informationen finden Sie unter Konventionen für Funktionsprototypen.
Anforderungen
| Anforderung | Wert |
|---|---|
| Unterstützte Mindestversion (Client) | Windows 2000 Professional [nur Desktop-Apps] |
| Unterstützte Mindestversion (Server) | Windows 2000 Server [nur Desktop-Apps] |
| Kopfzeile | winfax.h |
Weitere Informationen
Api-Strukturen des Faxdienstclients
Feedback
Bald verfügbar: Im Laufe des Jahres 2024 werden wir GitHub-Issues stufenweise als Feedbackmechanismus für Inhalte abbauen und durch ein neues Feedbacksystem ersetzen. Weitere Informationen finden Sie unter https://aka.ms/ContentUserFeedback.
Feedback senden und anzeigen für