Freigeben über


FaxEnumRoutingMethodsA-Funktion (winfax.h)

Die FaxEnumRoutingMethods Funktion listet alle Faxroutingmethoden für ein bestimmtes Faxgerät auf. Die Funktion gibt Informationen zu jeder Routingmethode an eine Faxclientanwendung zurück.

Syntax

WINFAXAPI BOOL FaxEnumRoutingMethodsA(
  [in]  HANDLE               FaxPortHandle,
  [out] PFAX_ROUTING_METHODA *RoutingMethod,
  [out] LPDWORD              MethodsReturned
);

Parameter

[in] FaxPortHandle

Typ: HANDLE

Gibt einen Faxporthandle an, der von einem Aufruf der FaxOpenPort-Funktion zurückgegeben wird.

[out] RoutingMethod

Typ: PFAX_ROUTING_METHOD*

Zeigen Sie auf die Adresse eines Puffers, um ein Array von FAX_ROUTING_METHOD Strukturen zu empfangen. Jede Struktur enthält Informationen zu einer Faxroutingmethode. Die Daten enthalten unter anderem den Namen der DLL, die die Routingmethode exportiert, die GUID und den Funktionsnamen, die die Routingmethode identifizieren, und den benutzerfreundlichen Namen der Methode.

Informationen zur Speicherzuweisung finden Sie im folgenden Abschnitt "Hinweise". Informationen zu Faxroutingmethoden finden Sie unter Informationen zur Faxweiterleitungs-API.

[out] MethodsReturned

Typ: LPDWORD-

Zeiger auf eine DWORD- Variable, um die Anzahl der FAX_ROUTING_METHOD Strukturen zu empfangen, die die FaxEnumRoutingMethods-Funktion im RoutingMethod Parameter zurückgibt.

Rückgabewert

Typ: BOOL-

Wenn die Funktion erfolgreich ist, ist der Rückgabewert ungleich Null.

Wenn die Funktion fehlschlägt, ist der Rückgabewert null. Rufen Sie GetLastErrorauf, um erweiterte Fehlerinformationen zu erhalten. GetLastError kann einen der folgenden Fehler zurückgeben.

Rückgabecode Beschreibung
ERROR_ACCESS_DENIED
Der Zugriff wurde verweigert. FAX_PORT_QUERY Zugriff ist erforderlich.
ERROR_INVALID_PARAMETER
Einer oder alle MethodsReturned, RoutingMethod-oder FaxPortHandle Parameter sind NULL-.
ERROR_NOT_ENOUGH_MEMORY
Fehler bei der Speicherzuweisung.

Bemerkungen

Eine Faxverwaltungsanwendung ruft in der Regel die FaxEnumRoutingMethods Funktion auf, um die faxweiterleitungsmethoden abzufragen, die einem bestimmten Gerät zugeordnet sind. Ein Aufruf der FaxSetRoutingInfo Funktion ändert die Routinginformationen für eine bestimmte Faxroutingmethode.

Die FaxEnumGlobalRoutingInfo Funktion ruft Routinginformationen ab, die global auf den Faxserver angewendet werden, z. B. die Routingpriorität. Eine Anwendung kann globale Daten mit einem Aufruf der FaxSetGlobalRoutingInfo Funktion ändern.

Die FaxEnumRoutingMethods--Funktion weist den für das FAX_ROUTING_METHOD Pufferarray erforderlichen Speicher zu, auf den der RoutingMethod-Parameter verweist. Eine Anwendung muss die FaxFreeBuffer--Funktion aufrufen, um die diesem Parameter zugeordneten Ressourcen zuzuordnen.

Weitere Informationen finden Sie unter Faxserver configuration management und Freeing Fax Resources.

Anmerkung

Der winfax.h-Header definiert FaxEnumRoutingMethods als Alias, der automatisch die ANSI- oder Unicode-Version dieser Funktion basierend auf der Definition der UNICODE-Präprozessorkonstante 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
mindestens unterstützte Client- Windows 2000 Professional [nur Desktop-Apps]
mindestens unterstützte Server- Windows 2000 Server [nur Desktop-Apps]
Zielplattform- Fenster
Header- winfax.h
Library WinFax.lib

Siehe auch

FAX_GLOBAL_ROUTING_INFO

FAX_ROUTING_METHOD

Faxdienst-Client-API-Funktionen

Faxdienst-Client-API für Windows 2000-

FaxEnableRoutingMethod

FaxEnumGlobalRoutingInfo

FaxFreeBuffer-

FaxGetRoutingInfo-

FaxOpenPort-

FaxSetGlobalRoutingInfo

FaxSetRoutingInfo-