FaxPrintCoverPageA-Funktion (winfax.h)

Artikel
08/27/2023

Die Funktion FaxPrintCoverPage druckt ein Faxübertragungs-Deckblatt im angegebenen Gerätekontext für eine Faxclientanwendung.

Syntax

WINFAXAPI BOOL FaxPrintCoverPageA(
  [in] const FAX_CONTEXT_INFOA   *FaxContextInfo,
  [in] const FAX_COVERPAGE_INFOA *CoverPageInfo
);

Parameter

[in] FaxContextInfo

Typ: const FAX_CONTEXT_INFO*

Zeiger auf eine FAX_CONTEXT_INFO-Struktur , die ein Handle für einen Faxdruckergerätekontext enthält.

[in] CoverPageInfo

Typ: const FAX_COVERPAGE_INFO*

Zeiger auf eine FAX_COVERPAGE_INFO Struktur, die personenbezogene Daten enthält, die auf dem Deckblatt des Faxdokuments angezeigt werden sollen.

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 CoverPageInfo - oder FaxContextInfo-Parameter sind NULL.
ERROR_INVALID_PARAMETER	Der SizeOfStruct-Member der angegebenen FAX_COVERPAGE_INFO-Struktur ist nicht gleich sizeof(FAX_COVERPAGE_INFO); oder der SizeOfStruct-Member der angegebenen FAX_CONTEXT_INFO-Struktur ist nicht gleich sizeof(FAX_CONTEXT_INFO).
ERROR_FILE_NOT_FOUND	Der Faxserver kann die vom CoverPageName-Element der FAX_COVERPAGE_INFO-Struktur angegebene Datei nicht finden.

Hinweise

Ein Gerätekontexthandle wird mithilfe der FaxStartPrintJob-Funktion abgerufen.

Das Deckblatt kann ein persönliches Deckblatt sein, das auf dem lokalen Computer gespeichert ist, oder es kann sich um ein allgemeines Deckblatt handeln, das auf dem Faxserver gespeichert ist.

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 muss die FaxStartPrintJob-Funktion aufrufen, bevor die FaxPrintCoverPage-Funktion aufgerufen wird, um ein Deckblatt mit einem Faxauftrag zu drucken. Weitere Informationen finden Sie unter Deckblätter und Drucken eines Faxs auf einen Gerätekontext.

Hinweis

Der winfax.h-Header definiert FaxPrintCoverPage 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]
Zielplattform	Windows
Kopfzeile	winfax.h
Bibliothek	WinFax.lib