FaxDevReportStatus-Funktion (faxdev.h)

Der Faxdienst ruft die FaxDevReportStatus-Funktion auf, um einen Faxdienstanbieter (FSP) nach status Informationen zu einem einzelnen aktiven Faxvorgang oder nach status Informationen nach einem fehlgeschlagenen Faxvorgang abzufragen. Jeder FSP muss die FaxDevReportStatus-Funktion exportieren.

Syntax

BOOL FaxDevReportStatus(
  [in]  HANDLE          FaxHandle,
  [out] PFAX_DEV_STATUS FaxStatus,
  [in]  DWORD           FaxStatusSize,
  [out] LPDWORD         FaxStatusSizeRequired
);

Parameter

[in] FaxHandle

Typ: HANDLE

Gibt ein Faxhandle an, das von der FaxDevStartJob-Funktion zurückgegeben wird, die dem Faxauftrag zugeordnet ist.

[out] FaxStatus

Typ: PFAX_DEV_STATUS

Zeiger auf eine FAX_DEV_STATUS-Struktur, die status- und Identifikationsinformationen empfängt. Dieser Parameter kann auch ein NULL-Zeiger sein. Weitere Informationen finden Sie im folgenden Abschnitt "Hinweise".

[in] FaxStatusSize

Art: DWORD

Gibt die Größe des Puffers in Bytes an, auf den der FaxStatus-Parameter verweist.

[out] FaxStatusSizeRequired

Typ: LPDWORD

Zeiger auf eine Variable, die die berechnete Größe des Puffers empfängt, der für eine FAX_DEV_STATUS Struktur erforderlich ist. Weitere Informationen finden Sie im folgenden Abschnitt "Hinweise".

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 abzurufen, ruft der Faxdienst GetLastError auf.

Hinweis Für ein erfolgreiches Senden sollte FaxDevSend() TRUE und FaxDevReportStatus() FS_COMPLETED zurückgeben. Bei nicht erfolgreichem Senden sollte FaxDevSend() FALSE zurückgeben, und FaxDevReportStatus() sollte einen der folgenden Codes zurückgeben: FS_LINE_UNAVAILABLE, FS_NO_ANSWER, FS_NO_DIAL_TONE, FS_DISCONNECTED, FS_BUSY, FS_NOT_FAX_CALL oder FS_FATAL_ERROR. Wenn das Fax nach einem fehlgeschlagenen Fax nicht erneut gesendet werden soll, sollte FaxDevReportStatus() einen anderen Code als die hier aufgeführten zurückgeben.
 

Hinweise

Um status Informationen für den Vorgang abzurufen, wird die FaxDevReportStatus-Funktion asynchron für einen Ausführungsthread aufgerufen, der vom Faxvorgang unabhängig ist. In der Regel ist es erforderlich, den Zugriff durch mehrere Threads zu synchronisieren. Weitere Informationen finden Sie unter Synchronisieren der Ausführung mehrerer Threads.

Wenn der FaxStatusSize-Parameter gleich 0 und FaxStatus ein NULL-Zeiger ist, muss der FSP die Größe des Puffers berechnen, der zum Aufnehmen einer FAX_DEV_STATUS-Struktur erforderlich ist. Der FSP muss diesen Wert im Parameter FaxStatusSizeRequired zurückgeben. Der Faxdienst ordnet dann den erforderlichen Arbeitsspeicher zu. Außerdem wird sowohl die Arbeitsspeichergröße im FaxStatusSize-Parameter als auch ein Zeiger auf diesen Speicher im FaxStatus-Parameter zurückgegeben.

Der FSP muss alle Elemente der FAX_DEV_STATUS-Struktur mit status Informationen für den aktiven Faxvorgang festlegen. Der Faxdienst weist den Arbeitsspeicher für die Zeichenfolgen zu, auf die die Elemente CSI, CallerId und RoutingInfo verweisen. Die Größe des vom Dienst zugewiesenen Arbeitsspeichers entspricht sizeof(FAX_DEV_STATUS) + FAXDEVREPORTSTATUS_SIZE. Der FSP muss die Zeichenfolgen in dem Speicherblock platzieren, der unmittelbar der FAX_DEV_STATUS-Struktur folgt. Die CSI-, CallerId- und RoutingInfo-Member müssen auf den Speicherort der Zeichenfolgen im Speicherblock verweisen.

Anforderungen

Anforderung Wert
Unterstützte Mindestversion (Client) Windows 2000 Professional, Windows XP [nur Desktop-Apps]
Unterstützte Mindestversion (Server) Windows Server 2003 [nur Desktop-Apps]
Zielplattform Windows
Kopfzeile faxdev.h

Weitere Informationen

FAX_DEV_STATUS

Faxdienstanbieterfunktionen

FaxDevStartJob

Verwenden der Faxdienstanbieter-API