FAX_PORT_INFOW-Struktur (winfax.h)

  • Artikel

Die FAX_PORT_INFO-Struktur beschreibt einen Faxport. Zu den Daten gehören unter anderem ein Gerätebezeichner, der Portname und die aktuelle status sowie 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 der FAX_PORT_INFO-Struktur in Bytes an. Die aufrufende Anwendung sollte sicherstellen, dass dieser Member auf sizeof(FAX_PORT_INFO) festgelegt ist, bevor die FaxSetPort-Funktion aufgerufen wird.

DeviceId

Art: DWORD

Gibt eine DWORD-Variable an, die den permanenten Zeilenbezeichner für das entsprechende Faxgerät angibt.

State

Art: DWORD

Gibt eine DWORD-Variable an, die ein Faxgerät status Code oder Wert ist. Bei diesem Member kann es sich um einen der im Folgenden gezeigten vordefinierten Geräte-status Codes handeln.

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, da es von einer anderen Anwendung verwendet wird.

FPS_BUSY

Das Gerät hat ein Ausgelastetes Signal gefunden.

FPS_NO_ANSWER

Das empfangende Gerät nahm den Anruf nicht an.

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 es keinen Wählton erkennt.

FPS_DISCONNECTED

Der Faxanruf wurde vom Absender oder anrufer getrennt.

FPS_FATAL_ERROR

Auf dem Gerät ist ein schwerwiegender Protokollfehler aufgetreten.

FPS_NOT_FAX_CALL

Das Gerät hat einen Datenanruf oder einen Sprachanruf empfangen.

FPS_CALL_DELAYED

Das Gerät verzögerte einen Faxanruf, weil das sendenden Gerät mehrmals ein Ausgelastungssignal empfangen hat. Das Gerät kann den Anruf nicht wiederholen, da Wählbeschränkungen bestehen. (Einige Länder/Regionen beschränken die Anzahl von Wiederholungsversuchen, wenn eine Zahl ausgelastet ist.)

FPS_CALL_BLACKLISTED

Das Gerät konnte einen Anruf nicht abschließen, weil die Telefonnummer blockiert oder reserviert war; Notrufnummern wie 911 sind 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 klingelt.

FPS_AVAILABLE

Das Gerät ist verfügbar.

FPS_ABORTING

Das Gerät bricht einen Faxauftrag ab.

FPS_ROUTING

Das Gerät routingt ein empfangenes Faxdokument.

FPS_ANSWERED

Das Gerät hat einen neuen Anruf angenommen.

FPS_HANDLED

Der Faxdienst verarbeitete das ausgehende Faxdokument. der Faxdienstanbieter übermittelt das Dokument.

Flags

Art: DWORD

Gibt eine DWORD-Variable an, bei der es sich um einen Satz von Bitflags handelt, die die Funktion des Faxports angeben. Dieser Member kann eine Kombination der folgenden Werte 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 ein Gerät nicht als virtuell festlegen können. Beim Aufrufen von FaxGetPort gibt der FPF_VIRTUAL wert des FAX_PORT_INFO Flags an, ob es sich um ein virtuelles Gerät handelt. 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 angibt, wie oft ein eingehender Faxanruf klingeln soll, bevor das angegebene Gerät den Anruf entgegengibt. Mögliche Werte sind 0 bis einschließlich 99. Dieser Wert wird ignoriert, es sei denn, das FPF_RECEIVE-Portfunktionsbitflag 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 diesen Member sind 1 bis n, wobei n der Wert des PortsReturned-Parameters ist, der von einem Aufruf der 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 usw. Der Wert des Priority-Elements hat keine Auswirkung auf eingehende Übertragungen.

DeviceName

Typ: LPCTSTR

Zeiger auf eine konstante NULL-endende Zeichenfolge, die den Namen des relevanten Faxgeräts angibt.

Tsid

Typ: LPCTSTR

Zeiger auf eine konstante NULL-endende Zeichenfolge, die die TSID angibt. Dieser Bezeichner ist in der Regel eine Telefonnummer. In einer TSID können nur druckbare Zeichen wie englische Buchstaben, numerische Symbole und Satzzeichen (ASCII-Bereich 0x20 bis 0x7F) verwendet werden.

Csid

Typ: LPCTSTR

Zeiger auf eine konstante NULL-endende Zeichenfolge, die den aufgerufenen Stationsbezeichner (CSID) angibt. Dieser Bezeichner ist in der Regel eine Telefonnummer. Nur druckbare Zeichen wie englische Buchstaben, numerische Symbole und Satzzeichen (ASCII-Bereich 0x20 bis 0x7F) können in einer CSID verwendet werden.

Hinweise

Eine Faxclientanwendung übergibt die FAX_PORT_INFO-Struktur in einem Aufruf der FaxSetPort-Funktion , um die Konfiguration des relevanten Faxports zu ändern.

Wenn eine Anwendung die FaxEnumPorts-Funktion aufruft , um alle derzeit an einen Faxserver angefügten Faxgeräte aufzulisten, gibt die Funktion ein Array von FAX_PORT_INFO-Strukturen zurück. Jede Struktur beschreibt ein Gerät im Detail. Wenn eine Anwendung die FaxGetPort-Funktion aufruft, um ein Gerät abzufragen, gibt diese Funktion Informationen über das 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 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]
Kopfzeile winfax.h

Weitere Informationen

Api-Strukturen des Faxdienstclients

Faxdienst-Client-API für Windows 2000

FaxEnumPorts

FaxGetPort

FaxSetPort

Virtuelle Faxgeräte