FaxEnableRoutingMethodA-Funktion (winfax.h)
Die FaxEnableRoutingMethod-Funktion aktiviert oder deaktiviert eine Faxweiterleitungsmethode für ein bestimmtes Faxgerät. Eine Faxverwaltungsanwendung ruft diese Funktion in der Regel für die Geräteverwaltung auf.
Syntax
WINFAXAPI BOOL FaxEnableRoutingMethodA(
[in] HANDLE FaxPortHandle,
[in] LPCSTR RoutingGuid,
[in] BOOL Enabled
);
Parameter
[in] FaxPortHandle
Typ: HANDLE
Gibt einen Faxportpunkt an, der von einem Aufruf der FaxOpenPort-Funktion zurückgegeben wird.
[in] RoutingGuid
Typ: LPCTSTR
Zeiger auf eine konstante null-beendete Zeichenzeichenfolge, die die GUID angibt, die die Faxweiterleitungsmethode eindeutig identifiziert.
Informationen zu Faxweiterleitungsmethoden finden Sie unter "Informationen zur Faxweiterleitungserweiterungs-API". Informationen zur Beziehung zwischen Routingmethoden und GUIDs finden Sie unter Fax-Routingmethoden.
[in] Enabled
Typ: BOOL
Gibt eine boolesche Variable an, die angibt, ob die Anwendung die durch den RoutingGuid-Parameter angegebene Faxweiterleitungsmethode aktiviert oder deaktiviert. Wenn dieser Parameter TRUE ist, aktiviert die Anwendung die Routingmethode; Wenn dieser Parameter FALSCH ist, deaktiviert die Anwendung die Routingmethode.
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 |
|---|---|
|
Eine oder beide der Parameter FaxPortHandle oder RoutingGuid sind NULL. |
|
Der RoutingGuid-Parameter ist ungültig. |
|
Zugriff verweigert.“ FAX_PORT_SET Zugriff ist erforderlich. |
Bemerkungen
Eine Faxclientanwendung kann die FaxEnableRoutingMethod-Funktion aufrufen, um eine Faxweiterleitungsmethode für ein bestimmtes Faxgerät zu aktivieren. Sie kann auch die Funktion aufrufen, um eine Routingmethode zu deaktivieren, die durch einen vorherigen Aufruf von FaxEnableRoutingMethod oder von der Faxdienstverwaltungsanwendung aktiviert ist. Weitere Informationen finden Sie unter Verwalten von Faxweiterleitungsdaten.
Rufen Sie die FaxOpenPort-Funktion auf, um einen gültigen Porthandle abzurufen, der im FaxPortHandle-Parameter angegeben werden soll.
Hinweis
Der winfax.h-Header definiert FaxEnableRoutingMethod 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] |
| Zielplattform | Windows |
| Kopfzeile | winfax.h |
| Bibliothek | WinFax.lib |
Weitere Informationen
Client-API-Funktionen des Faxdiensts