PFAXGETPAGEDATA-Rückruffunktion (winfax.h)

Artikel
08/27/2023

Die FaxGetPageData-Funktion gibt die erste Seite der Daten für einen Faxauftrag an eine Faxclientanwendung zurück. Der Faxauftrag muss ein ausgehender Auftrag sein, kann aber in einer Warteschlange oder aktiv sein. Die Funktion gibt Daten im Tagged Image File Format Class F (TIFF Class F) zurück.

Syntax

PFAXGETPAGEDATA Pfaxgetpagedata;

BOOL Pfaxgetpagedata(
  [in]  HANDLE FaxHandle,
  [in]  DWORD JobId,
  [out] LPBYTE *Buffer,
  [out] LPDWORD BufferSize,
  [out] LPDWORD ImageWidth,
  [out] LPDWORD ImageHeight
)
{...}

Parameter

[in] FaxHandle

Typ: HANDLE

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

[in] JobId

Art: DWORD

Gibt eine eindeutige Zahl an, die den Faxauftrag identifiziert, der der Datenseite zugeordnet ist.

[out] Buffer

Typ: LPBYTE*

Zeiger auf die Adresse eines Puffers, um die erste Seite der Daten im Faxdokument zu empfangen. Informationen zur Speicherzuordnung finden Sie im folgenden Abschnitt mit den Anmerkungen.

[out] BufferSize

Typ: LPDWORD

Zeiger auf eine DWORD-Variable , um die Größe des Puffers in Bytes zu empfangen, auf die der Buffer-Parameter verweist.

[out] ImageWidth

Typ: LPDWORD

Zeiger auf eine DWORD-Variable , um die Breite des Faxbilds in Pixel zu empfangen.

[out] ImageHeight

Typ: LPDWORD

Zeiger auf eine DWORD-Variable , um die Höhe des Faxbilds in Pixel zu empfangen.

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_ACCESS_DENIED	Zugriff verweigert.“ FAX_JOB_QUERY Zugriff ist erforderlich.
ERROR_INVALID_PARAMETER	Einer oder alle Parameter Buffer, BufferSize, ImageWidth, ImageHeight oder FaxHandle sind NULL.
ERROR_NOT_ENOUGH_MEMORY	Während der Speicherzuordnung ist ein Fehler aufgetreten.
ERROR_INVALID_DATA	Ein Fehler mit ungültigen Daten ist aufgetreten. Beispielsweise handelt es sich bei dem durch den JobId-Parameter identifizierten Faxauftrag nicht um eine ausgehende Faxübertragung. der Auftrag muss mit dem JT_SEND Auftragstyp angegeben werden.

Hinweise

Eine Faxclientanwendung kann die FaxGetPageData-Funktion zu Administrativen Zwecken aufrufen, um eine Miniaturansicht der Faxdokumente in der Faxwarteschlange anzuzeigen.

Der Faxdienst erstellt Faxdokumente als TIFF-Klasse F-Dateien basierend auf der TIFF 6.0-Spezifikation (TIFF) 6.0. Die FaxGetPageData-Funktion gibt einen TIFF-Datenstream zurück, der über ein zweidimensionales Format für die Datenkomprimierung geänderter geänderter READ-Codierung (MMR) verfügt. Die aufrufende Anwendung muss den Datenstrom decodieren. Weitere Informationen finden Sie unter Faxbildformat.

Die FaxGetPageData-Funktion weist den für den Buffer-Parameter erforderlichen Arbeitsspeicher zu. Eine Anwendung muss die FaxFreeBuffer-Funktion aufrufen, um die Zuordnung der Ressourcen zu beheben, die diesem Parameter zugeordnet sind.

Weitere Informationen finden Sie unter Anzeigen von Dokumenten in der Faxauftragswarteschlange und Freigeben von Faxressourcen.

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