FAX_JOB_PARAMA-Struktur (winfax.h)
Die FAX_JOB_PARAM-Struktur enthält die Informationen, die der Faxserver zum Senden einer einzelnen Faxübertragung benötigt. Die Struktur enthält die Faxnummer des Empfängers, Absender- und Empfängerdaten, einen optionalen Abrechnungscode und Auftragsplanungsinformationen.
Die Member SizeOfStruct, RecipientNumber und ScheduleAction sind erforderlich. andere Member sind optional.
Syntax
typedef struct _FAX_JOB_PARAMA {
DWORD SizeOfStruct;
LPCSTR RecipientNumber;
LPCSTR RecipientName;
LPCSTR Tsid;
LPCSTR SenderName;
LPCSTR SenderCompany;
LPCSTR SenderDept;
LPCSTR BillingCode;
DWORD ScheduleAction;
SYSTEMTIME ScheduleTime;
DWORD DeliveryReportType;
LPCSTR DeliveryReportAddress;
LPCSTR DocumentName;
HCALL CallHandle;
DWORD_PTR Reserved[3];
} FAX_JOB_PARAMA, *PFAX_JOB_PARAMA;
Member
SizeOfStruct
Art: DWORD
Gibt die Größe der FAX_JOB_PARAM-Struktur in Bytes an. Die aufrufende Anwendung muss diesen Member auf sizeof(FAX_JOB_PARAM) festlegen. Dieser Member ist erforderlich.
RecipientNumber
Typ: LPCTSTR
Zeiger auf eine konstante NULL-endende Zeichenfolge, die die Faxnummer des Empfängers der Faxübertragung angibt. Dieser Member ist erforderlich.
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 Übertragungsstationsbezeichner (Transmission Station Identifier, TSID) angibt. Dieser Bezeichner ist in der Regel eine Telefonnummer. In einer TSID können nur druckbare Zeichen wie englische Buchstaben, numerische Symbole und Satzzeichen (ASCII-Bereich 0x20 bis 0x7F) verwendet werden.
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. Dieser Member ist erforderlich und kann eine der folgenden vordefinierten Aufgabenplanungsaktionen sein.
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 Informationsspeicher 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.
CallHandle
Typ: HCALL
Reserviert, und sollte NULL sein.
Reserved[3]
Typ: DWORD_PTR[3]
Dieses Mitglied ist für die zukünftige Verwendung durch Microsoft reserviert. Er muss auf 0 (null) festgelegt werden.
Hinweise
Eine Faxclientanwendung übergibt die FAX_JOB_PARAM-Struktur in einem Aufruf der FaxSendDocument-Funktion , um den Faxserver darüber zu informieren, wie und wann die Faxübertragung gesendet werden soll. Weitere Informationen finden Sie unter Senden eines Faxs an einen Empfänger (Win32-Umgebung).
Hinweis
Der winfax.h-Header definiert FAX_JOB_PARAM 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
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