PFAXOPENPORT-Rückruffunktion (winfax.h)

Artikel
08/27/2023

Die FaxOpenPort-Funktion gibt ein Faxporthandle an eine Faxclientanwendung zurück. Das Porthandle ist erforderlich, wenn die Anwendung andere Faxclientfunktionen aufruft, die die Geräteverwaltung und das Faxdokumentrouting erleichtern.

Syntax

PFAXOPENPORT Pfaxopenport;

BOOL Pfaxopenport(
  [in]  HANDLE FaxHandle,
  [in]  DWORD DeviceId,
  [in]  DWORD Flags,
  [out] LPHANDLE FaxPortHandle
)
{...}

Parameter

[in] FaxHandle

Typ: HANDLE

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

[in] DeviceId

Art: DWORD

Gibt eine DWORD-Variable an, die der permanente Zeilenbezeichner für das empfangende Gerät ist. Rufen Sie die FaxEnumPorts-Funktion auf, um einen gültigen Wert für diesen Parameter abzurufen. Weitere Informationen finden Sie im folgenden Abschnitt "Hinweise".

[in] Flags

Art: DWORD

Gibt eine DWORD-Variable an, die eine Reihe von Bitflags enthält, die die Zugriffsebene für den Port definiert. Dieser Parameter kann einen oder mehrere der folgenden Werte aufweisen.

PORT_OPEN_QUERY

Portzugriffsebene erforderlich, um ein Faxporthandle abzurufen. Diese Zugriffsebene ist auch erforderlich, um die FaxGetPort-Funktion zum Abfragen von Faxportinformationen aufzurufen.

PORT_OPEN_MODIFY

Portzugriffsebene erforderlich, um die Konfiguration eines Faxports mit einem Aufruf der FaxGetPort-Funktion zu ändern. Diese Zugriffsebene umfasst auch die Zugriffsrechte, die der PORT_OPEN_QUERY Zugriffsebene zugeordnet sind.

[out] FaxPortHandle

Typ: LPHANDLE

Zeiger auf eine Variable, die ein Faxporthandle empfängt, das bei nachfolgenden Aufrufen anderer Faxclientfunktionen erforderlich ist. Wenn der Faxserver ein NULL-Handle zurückgibt, wird ein Fehler angezeigt.

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	Der Zugriff wird verweigert. FAX_PORT_QUERY Zugriff ist erforderlich.
ERROR_NOT_ENOUGH_MEMORY	Während der Speicherzuordnung ist ein Fehler aufgetreten.
ERROR_INVALID_HANDLE	Der Port wurde bereits mit PORT_OPEN_MODIFY Zugriff geöffnet.
ERROR_BAD_UNIT	Der DeviceId-Parameter ist ungültig.

Hinweise

Rufen Sie die FaxOpenPort-Funktion auf, um das Handle an einen Faxport abzurufen. Verwenden Sie das Handle, wenn Sie die folgenden Funktionen aufrufen:

FaxSetPort zum Ändern der Konfiguration des Ports
FaxEnumRoutingMethods zum Abrufen von Informationen über die Faxroutingmethoden, die einem Gerät zugeordnet sind

Die FaxEnumPorts-Funktion gibt ein Array von FAX_PORT_INFO Strukturen zurück. Jede Struktur enthält detaillierte Informationen für einen Port, einschließlich eines gültigen Werts, der im DeviceId-Parameter übergeben werden soll. Eine Anwendung sollte diesen Gerätebezeichner nicht dauerhaft speichern, da sich der Bezeichner zwischen Funktionsaufrufen des Faxservers ändern kann.

Weitere Informationen finden Sie unter Faxports, Fax Geräteverwaltung und Verwalten von Faxroutingdaten.

Anforderungen


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