FaxStartPrintJobA-Funktion (winfax.h)
Eine Faxclientanwendung ruft die FaxStartPrintJob-Funktion auf, um das Drucken einer ausgehenden Faxübertragung auf dem angegebenen Faxdrucker zu starten.
Syntax
WINFAXAPI BOOL FaxStartPrintJobA(
[in] LPCSTR PrinterName,
[in] const FAX_PRINT_INFOA *PrintInfo,
[out] LPDWORD FaxJobId,
[out] PFAX_CONTEXT_INFOA FaxContextInfo
);
Parameter
[in] PrinterName
Typ: LPCTSTR
Zeiger auf eine konstante NULL-endende Zeichenfolge, die den Namen eines Faxdruckers enthält. Die Zeichenfolge kann eine der folgenden Angaben angeben:
- Ein lokaler Drucker, z. B. "printername"
- Ein Netzwerkdrucker, z. B. "\\computername\printername"
- NULL zum Angeben des lokalen Faxdruckers
[in] PrintInfo
Typ: const FAX_PRINT_INFO*
Zeiger auf eine FAX_PRINT_INFO Struktur, die die Informationen enthält, die der Faxserver zum Drucken der Faxübertragung benötigt. Die Struktur umfasst unter anderem die Faxnummer des Empfängers, Absender- und Empfängerdaten, einen optionalen Abrechnungscode und Informationen zum Lieferbericht. Weitere Informationen finden Sie im folgenden Abschnitt "Hinweise".
[out] FaxJobId
Typ: LPDWORD
Zeiger auf eine DWORD-Variable , um die eindeutige ID des Druckspoolers für den Faxdruckauftrag zu empfangen. (Dies ist nicht identisch mit der ID der Faxwarteschlange für den Auftrag und kann nicht als Parameter in einer Fax-API verwendet werden, die einen Fax-ID-Parameter akzeptiert.) Dieser Parameter ist erforderlich.
[out] FaxContextInfo
Typ: PFAX_CONTEXT_INFO
Zeiger auf eine FAX_CONTEXT_INFO Struktur, um ein Handle für einen Druckergerätekontext zu empfangen. Wenn die Faxclientanwendung die FaxPrintCoverPage-Funktion aufruft, muss sie diesen Wert im FaxContextInfo-Parameter dieser Funktion übergeben. Weitere Informationen finden Sie unter Gerätekontexte und in der Referenz zum Drucken und Drucken von Spoolern.
Rückgabewert
Typ: BOOL
Wenn die Funktion erfolgreich ist, ist der Rückgabewert ungleich Null.
Wenn die Funktion fehlerhaft ist, ist der Rückgabewert null. Um erweiterte Fehlerinformationen zu erhalten, rufen Sie GetLastError auf. GetLastError kann einen der folgenden Fehler zurückgeben.
Rückgabecode | Beschreibung |
---|---|
|
Einer oder beide der PrintInfo - oder FaxContextInfo-Parameter sind NULL. |
|
Das RecipientNumber-Element der FAX_PRINT_INFO-Struktur ist NULL; oder das OutputFileName-Element ist NULL , und das RecipientNumber-Element ist nicht angegeben. |
|
Der Parameter PrinterName gibt einen Drucker an, der kein Faxdrucker ist, oder es ist kein Faxdrucker installiert. |
|
Während der Speicherbelegung ist ein Fehler aufgetreten. |
|
FaxStartPrintJob wurde zuerst nicht aufgerufen, daher gab es keinen StartDoc-Anruf . |
Hinweise
Die Funktion gibt ein Handle an einen Gerätekontext zurück. Das Handle wird von der FaxPrintCoverPage-Funktion und von den Funktionen AbortDoc, EndDoc, DeleteDC, StartPage, EndPage und anderen Win32-Funktionen GDI (Windows Graphics Device Interface) verwendet.
Die Änderung verhindert die Anzeige des Faxversand-Assistenten, der Informationen vom Benutzer sammelt. Der Faxserver verwendet die Daten in der FAX_PRINT_INFO Struktur, auf die der PrintInfo-Parameter verweist, um die Faxübertragung zu drucken. Diese Struktur enthält Daten, die der Faxversand-Assistent gesammelt hätte, wenn der Assistent angezeigt worden wäre.
Eine Faxclientanwendung muss die FaxStartPrintJob-Funktion aufrufen, bevor die FaxPrintCoverPage-Funktion aufgerufen wird, um ein Deckblatt mit einem Faxauftrag zu drucken.
Hinweis
Der winfax.h-Header definiert FaxStartPrintJob 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] |
Zielplattform | Windows |
Kopfzeile | winfax.h |
Bibliothek | WinFax.lib |
Weitere Informationen
Api-Funktionen des Faxdienstclients
Feedback
https://aka.ms/ContentUserFeedback.
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 unterFeedback senden und anzeigen für