FaxSendDocumentA-Funktion (winfax.h)

Artikel
08/27/2023

Eine Faxclientanwendung ruft die FaxSendDocument-Funktion auf, um einen Faxauftrag in die Warteschlange zu stellen, der eine ausgehende Faxübertragung sendet.

Syntax

WINFAXAPI BOOL FaxSendDocumentA(
  [in]           HANDLE                    FaxHandle,
  [in]           LPCSTR                    FileName,
  [in]           PFAX_JOB_PARAMA           JobParams,
  [in, optional] const FAX_COVERPAGE_INFOA *CoverpageInfo,
  [out]          LPDWORD                   FaxJobId
);

Parameter

[in] FaxHandle

Typ: HANDLE

Gibt ein Faxserverhandle an, das von einem Aufruf der FaxConnectFaxServer-Funktion zurückgegeben wird.

[in] FileName

Typ: LPCTSTR

Zeiger auf eine konstante NULL-Zeichenfolge, die den vollqualifizierten Pfad und den Namen der Datei enthält, die das zu übertragende Faxdokument enthält. Der Pfad kann ein UNC-Pfad oder ein Pfad sein, der mit einem Laufwerkbuchstaben beginnt.

Dieser Parameter kann einen beliebigen gültigen lokalen Dateinamen enthalten. Die Datei muss ein ordnungsgemäß registrierter Dateityp sein, und der Faxserver muss auf die Datei zugreifen können.

[in] JobParams

Typ: PFAX_JOB_PARAM

Zeiger auf eine FAX_JOB_PARAM Struktur, die die Informationen enthält, die für den Faxserver zum Senden der Faxübertragung erforderlich sind. Die Struktur enthält unter anderem die Faxnummer, Absender- und Empfängerdaten des Empfängers, einen optionalen Abrechnungscode und Informationen zur Auftragsplanung.

[in, optional] CoverpageInfo

Typ: const FAX_COVERPAGE_INFO*

Zeiger auf eine FAX_COVERPAGE_INFO Struktur, die personenbezogene Daten enthält, die auf der Deckseite des Faxdokuments angezeigt werden sollen. Dieser Parameter muss NULL sein, wenn kein Deckblatt erforderlich ist.

[out] FaxJobId

Typ: LPDWORD

Zeiger auf eine DWORD-Variable , um eine eindeutige Zahl zu erhalten, die den in die Warteschlange eingereihten Auftrag identifiziert, der die Faxübertragung sendet.

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 alle Parameter FaxHandle, JobParams oder FileName sind NULL. das vom CallHandle-Member der FAX_JOB_PARAM-Struktur angegebene Aufrufhandle ist ungültig (sollte NULL sein), oder das RecipientNumber-Element in der FAX_JOB_PARAM-Struktur ist NULL.
ERROR_INVALID_FUNCTION	Der FaxHandle-Parameter gibt eine Remoteverbindung an, aber das CallHandle-Element der FAX_JOB_PARAM-Struktur ist nicht NULL.
ERROR_ACCESS_DENIED	Zugriff verweigert.“ FAX_JOB_SUBMIT Zugriff ist erforderlich.
ERROR_FILE_NOT_FOUND	Der Faxserver kann die durch den Parameter FileName oder CoverpageInfo angegebene Datei nicht finden.
ERROR_INVALID_DATA	Der Faxserver kann die durch den Parameter FileName oder CoverpageInfo angegebene Datei nicht verarbeiten.
ERROR_NOT_SUPPORTED	Unter Verwendung des CallHandle-Elements der FAX_JOB_PARAM-Struktur wurde versucht, einen Sprachanruf zum Senden eines Faxs zu senden. Dies wird nicht unterstützt.

Hinweise

Rufen Sie die FaxCompleteJobParams-Funktion auf, bevor Sie die FaxSendDocument-Funktion aufrufen. FaxCompleteJobParams ist eine Hilfsfunktion, die mehrere Member in den FAX_COVERPAGE_INFO - und FAX_JOB_PARAM-Strukturen mit Informationen wie dem Namen des Absenders, der Faxnummer und optionalen Abrechnungscodeinformationen ausfüllt.

Die FaxSendDocument-Funktion wird asynchron ausgeführt, und die Funktion wird sofort zurückgegeben. Der Faxserver stellt den Auftrag zum Senden der Faxübertragung gemäß den in der FAX_JOB_PARAM-Struktur angegebenen Details in die Warteschlange.

Damit FaxSendDocument erfolgreich ist, muss auf dem Faxserver ein Remotefaxdrucker installiert sein.

Um ein Faxdokument effizient an mehrere Empfänger zu senden, sollte eine Anwendung die FaxSendDocument-Funktion mehrmals aufrufen. Die FaxSendDocumentForBroadcast-Funktion wird aus Gründen der Abwärtskompatibilität unterstützt.

Wenn Sie ein Dokument aus einer Anwendung senden, können Links im Dokument dazu führen, dass ein Dialogfeld angezeigt wird, in dem Informationen angefordert werden. Wenn Sie die Informationsanforderung nicht innerhalb weniger Minuten verarbeiten, schlägt FaxSendDocument fehl und gibt einen Fehler zurück.

Hinweis

Der winfax.h-Header definiert FaxSendDocument 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 nicht codierungsneutralem Code 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