FaxStartPrintJobA-Funktion (winfax.h)

Artikel
08/27/2023

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
ERROR_INVALID_PARAMETER	Einer oder beide der PrintInfo - oder FaxContextInfo-Parameter sind NULL.
ERROR_INVALID_PARAMETER	Das RecipientNumber-Element der FAX_PRINT_INFO-Struktur ist NULL; oder das OutputFileName-Element ist NULL , und das RecipientNumber-Element ist nicht angegeben.
ERROR_INVALID_PRINTER_NAME	Der Parameter PrinterName gibt einen Drucker an, der kein Faxdrucker ist, oder es ist kein Faxdrucker installiert.
ERROR_NOT_ENOUGH_MEMORY	Während der Speicherbelegung ist ein Fehler aufgetreten.
ERROR_SPL_NO_STARTDOC	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.

Hinweis Die Anwendung muss auch die AbortDoc-Funktion oder die EndDoc-Funktion aufrufen, um den Druckauftrag abzuschließen, und die DeleteDC-Funktion aufrufen, um die Zuordnung des Handles zum Kontext des Druckergeräts zu aufheben. Weitere Informationen finden Sie unter Drucken eines Faxs an einen Gerätekontext.

Eine Faxclientanwendung sollte die CreateDC GDI-Funktion nicht aufrufen, um den Kontext des Faxdruckergeräts zu erstellen. sie sollte auch nicht die StartPage-Druckfunktion aufrufen, um einen Faxdruckauftrag zu starten. Stattdessen sollte die Anwendung die FaxStartPrintJob-Funktion aufrufen. Dies liegt daran, dass FaxStartPrintJob Informationen in der DEVMODE-Struktur speziell für den gewünschten Faxdrucker ändert.

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