FAX_PORT_INFOW Struktur (winfax.h)
Die FAX_PORT_INFO Struktur beschreibt einen Faxport. Die Daten umfassen unter anderem einen Gerätebezeichner, den Namen des Ports und den aktuellen Status und die Stationsbezeichner.
Syntax
typedef struct _FAX_PORT_INFOW {
DWORD SizeOfStruct;
DWORD DeviceId;
DWORD State;
DWORD Flags;
DWORD Rings;
DWORD Priority;
LPCWSTR DeviceName;
LPCWSTR Tsid;
LPCWSTR Csid;
} FAX_PORT_INFOW, *PFAX_PORT_INFOW;
Member
SizeOfStruct
Art: DWORD
Gibt die Größe in Bytes der FAX_PORT_INFO Struktur an. Die aufrufende Anwendung sollte sicherstellen, dass dieses Element auf sizeof(FAX_PORT_INFO) festgelegt ist, bevor er die FaxSetPort-Funktion aufruft.
DeviceId
Art: DWORD
Gibt eine DWORD-Variable an, die den dauerhaften Zeilenbezeichner für das Faxgerät angibt.
State
Art: DWORD
Gibt eine DWORD-Variable an, die ein Faxgerätstatuscode oder ein Wert ist. Dieses Element kann eine der vordefinierten Gerätestatuscodes sein, die nachfolgend angezeigt werden.
FPS_DIALING
Das Gerät wählt eine Faxnummer.
FPS_SENDING
Das Gerät sendet ein Faxdokument.
FPS_RECEIVING
Das Gerät empfängt ein Faxdokument.
FPS_COMPLETED
Das Gerät hat das Senden oder Empfangen einer Faxübertragung abgeschlossen.
FPS_UNAVAILABLE
Das Gerät ist nicht verfügbar, weil es von einer anderen Anwendung verwendet wird.
FPS_BUSY
Das Gerät hat ein gebuchtes Signal gefunden.
FPS_NO_ANSWER
Das empfangende Gerät hat den Anruf nicht beantwortet.
FPS_BAD_ADDRESS
Das Gerät wählte eine ungültige Faxnummer.
FPS_NO_DIAL_TONE
Das sendende Gerät kann den Anruf nicht abschließen, da er keinen Wählton erkennt.
FPS_DISCONNECTED
Der Faxanruf wurde vom Absender oder dem Anrufer getrennt.
FPS_FATAL_ERROR
Das Gerät hat einen tödlichen Protokollfehler gefunden.
FPS_NOT_FAX_CALL
Das Gerät hat einen Datenanruf oder einen Sprachanruf empfangen.
FPS_CALL_DELAYED
Das Gerät verzögerte einen Faxanruf, da das sendende Gerät mehrmals ein gebuchtes Signal empfangen hat. Das Gerät kann den Anruf nicht wiederholen, da Die Einwahleinschränkungen vorhanden sind. (Einige Länder/Regionen beschränken die Anzahl der Wiederholungsversuche, wenn eine Zahl beschäftigt ist.)
FPS_CALL_BLACKLISTED
Das Gerät konnte keinen Anruf abschließen, weil die Telefonnummer blockiert oder reserviert wurde; Notrufnummern wie 911 werden blockiert.
FPS_INITIALIZING
Das Gerät initialisiert einen Anruf.
FPS_OFFLINE
Das Gerät ist offline und nicht verfügbar.
FPS_RINGING
Das Gerät wird klingeln.
FPS_AVAILABLE
Das Gerät ist verfügbar.
FPS_ABORTING
Das Gerät wird von einem Faxauftrag abgebrochen.
FPS_ROUTING
Das Gerät wird ein empfangenes Faxdokument weiterleiten.
FPS_ANSWERED
Das Gerät hat einen neuen Anruf beantwortet.
FPS_HANDLED
Der Faxdienst verarbeitet das ausgehende Faxdokument; Der Faxdienstanbieter sendet das Dokument.
Flags
Art: DWORD
Gibt eine DWORD-Variable an, die eine Reihe von Bit-Flags ist, die die Funktion des Faxports angeben. Dieses Element kann eine Kombination aus den folgenden Werten sein.
FPF_RECEIVE
Das Gerät kann Faxe empfangen.
FPF_SEND
Das Gerät kann Faxe senden.
FPF_VIRTUAL
Das Gerät ist ein virtuelles Faxgerät. Weitere Informationen finden Sie unter Virtuelle Faxgeräte. Beachten Sie, dass Sie kein Gerät auf virtuelle Geräte festlegen können. Beim Aufrufen von FaxGetPort gibt der FPF_VIRTUAL-Wert des FAX_PORT_INFO Flags an, ob das Gerät virtual ist. Beim Aufrufen von FaxSetPort bezieht sich der Dienst nur auf die werte FPF_RECEIVE und FPF_SEND .
Rings
Art: DWORD
Gibt eine DWORD-Variable an, die die Anzahl der Zeiten angibt, in denen ein eingehender Faxanruf aufgerufen werden soll, bevor das angegebene Gerät den Anruf beantwortet. Mögliche Werte sind von 0 bis 99 inklusive. Dieser Wert wird ignoriert, es sei denn, die FPF_RECEIVE Portfunktionsbit-Flag ist festgelegt.
Priority
Art: DWORD
Gibt eine DWORD-Variable an, die die relative Reihenfolge bestimmt, in der verfügbare Faxgeräte ausgehende Übertragungen senden. Gültige Werte für dieses Element sind 1 bis n, wobei n der Wert des PortsReturned-Parameters ist, der von einem Aufruf an die FaxEnumPorts-Funktion zurückgegeben wird.
Wenn der Faxserver eine ausgehende Faxübertragung initiiert, versucht er, das Gerät mit der höchsten Priorität und FPF_SEND Portfunktion auszuwählen. Wenn dieses Gerät nicht verfügbar ist, wählt der Server das nächste verfügbare Gerät aus, das in der Rangfolge folgt, und so weiter. Der Wert des Prioritätsmitglieds hat keine Auswirkung auf eingehende Übertragungen.
DeviceName
Typ: LPCTSTR
Zeiger auf eine konstante NULL-beendete Zeichenzeichenfolge, die den Namen des Faxgeräts angibt, das interessesfrei ist.
Tsid
Typ: LPCTSTR
Zeiger auf eine konstante NULL-beendete Zeichenzeichenfolge, die die TSID angibt. Dieser Bezeichner ist in der Regel eine Telefonnummer. Nur druckbare Zeichen wie englische Buchstaben, numerische Symbole und Zeichenzeichen (ASCII-Bereich 0x20 bis 0x7F) können in einer TSID verwendet werden.
Csid
Typ: LPCTSTR
Zeiger auf eine konstante NULL-beendete Zeichenzeichenfolge, die den aufgerufenen Station-Bezeichner (CSID) angibt. Dieser Bezeichner ist in der Regel eine Telefonnummer. Nur druckbare Zeichen wie englische Buchstaben, numerische Symbole und Satzzeichen (ASCII-Bereich 0x20 zu 0x7F) können in einer CSID verwendet werden.
Hinweise
Eine Faxclientanwendung übergibt die FAX_PORT_INFO Struktur in einem Aufruf an die FaxSetPort-Funktion , um die Konfiguration des Faxports von Interesse zu ändern.
Wenn eine Anwendung die FaxEnumPorts-Funktion aufruft, um alle faxgeräte aufzählen zu können, die derzeit an einen Faxserver angefügt sind, gibt die Funktion ein Array von FAX_PORT_INFO Strukturen zurück. Jede Struktur beschreibt ein Gerät ausführlich. Wenn eine Anwendung die FaxGetPort-Funktion aufruft, um ein Gerät abzufragen, gibt diese Funktion Informationen zum Gerät in einer FAX_PORT_INFO Struktur zurück. Weitere Informationen finden Sie unter Faxports und Fax-Geräteverwaltung.
Hinweis
Der winfax.h-Header definiert FAX_PORT_INFO als Alias, der die ANSI- oder Unicode-Version dieser Funktion basierend auf der Definition der UNICODE-Präprozessorkonstante automatisch auswählt. Das Mischen der codierungsneutralen Aliase mit Code, der nicht codierungsneutral ist, kann zu Ü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] |
| Header | winfax.h |
Weitere Informationen
Client-API-Strukturen des Faxdiensts