WSAAsyncGetProtoByName-Funktion (winsock2.h)
Die WSAAsyncGetProtoByName-Funktion ruft asynchron Protokollinformationen ab, die einem Protokollnamen entsprechen.
Syntax
HANDLE WSAAPI WSAAsyncGetProtoByName(
[in] HWND hWnd,
[in] u_int wMsg,
[in] const char *name,
[out] char *buf,
[out] int buflen
);
Parameter
[in] hWnd
Handle des Fensters, das eine Nachricht empfängt, wenn die asynchrone Anforderung abgeschlossen ist.
[in] wMsg
Nachricht, die empfangen werden soll, wenn die asynchrone Anforderung abgeschlossen ist.
[in] name
Zeiger auf den zu auflösenden Protokollnamen mit NULL-Beendigung.
[out] buf
Zeiger auf den Datenbereich, um die Protoensdaten zu empfangen. Der Datenbereich muss größer als die Größe einer Protoensstruktur sein, da der Datenbereich von Windows Sockets verwendet wird, um eine Protoensstruktur und alle Daten zu enthalten, auf die von Elementen der Protoentenstruktur verwiesen wird. Ein Puffer von MAXGETHOSTSTRUCT-Bytes wird empfohlen.
[out] buflen
Größe des Datenbereichs für den buf-Parameter in Bytes.
Rückgabewert
Der Rückgabewert gibt an, ob der asynchrone Vorgang erfolgreich initiiert wurde. Dies impliziert keinen Erfolg oder Misserfolg des Vorgangs selbst.
Wenn kein Fehler auftritt, gibt WSAAsyncGetProtoByName einen nonzero-Wert vom Typ HANDLE zurück, der das asynchrone Aufgabenhandle für die Anforderung ist (nicht mit einem Windows HTASK zu verwechseln). Dieser Wert kann auf zwei Arten verwendet werden. Es kann verwendet werden, um den Vorgang mit WSACancelAsyncRequest abzubrechen, oder es kann verwendet werden, um asynchrone Vorgänge und Vervollständigungsmeldungen abzugleichen, indem der wParam-Nachrichtenparameter untersucht wird.
Wenn der asynchrone Vorgang nicht initiiert werden konnte, gibt WSAAsyncGetProtoByName einen Nullwert zurück, und eine bestimmte Fehlernummer kann abgerufen werden, indem WSAGetLastError aufgerufen wird.
Die folgenden Fehlercodes können festgelegt werden, wenn ein Anwendungsfenster eine Nachricht empfängt. Wie oben beschrieben, können sie aus dem lParam in der Antwortnachricht mithilfe des WSAGETASYNCERROR-Makros extrahiert werden.
| Fehlercode | Bedeutung |
|---|---|
| Beim Netzwerksubsystem ist ein Fehler aufgetreten. | |
| Es ist nicht genügend Pufferspeicher verfügbar. | |
| Der Name oder buf-Parameter befindet sich nicht in einem gültigen Teil des Prozessadressraums. | |
| Autorisierendes Antwortprotokoll wurde nicht gefunden. | |
| Ein nicht authentifiziertes Protokoll nicht gefunden oder ein Serverfehler. | |
| Nicht behebbare Fehler, auf die Protokolldatenbank kann nicht zugegriffen werden. | |
| Gültiger Name, kein Datensatz des angeforderten Typs. |
Die folgenden Fehler können zum Zeitpunkt des Funktionsaufrufs auftreten und zeigen an, dass der asynchrone Vorgang nicht initiiert werden konnte.
| Fehlercode | Bedeutung |
|---|---|
| WSANOTINITIALISED | Vor der Verwendung dieser Funktion muss ein erfolgreicher WSAStartup-Aufruf erfolgen. |
| WSAENETDOWN | Beim Netzwerksubsystem ist ein Fehler aufgetreten. |
| WSAEINPROGRESS | Ein blockierter Windows Sockets 1.1-Aufruf wird ausgeführt, oder der Dienstanbieter verarbeitet weiterhin eine Rückruffunktion. |
| WSAEWOULDBLOCK | Der asynchrone Vorgang kann derzeit aufgrund von Ressourcen oder anderen Einschränkungen innerhalb der Windows Sockets-Implementierung nicht geplant werden. |
Hinweise
Die WSAAsyncGetProtoByName-Funktion ist eine asynchrone Version von getprotobyname. Es wird verwendet, um den Protokollnamen und die Nummer aus der Windows Sockets-Datenbank abzurufen, die einem angegebenen Protokollnamen entspricht. Windows Sockets initiiert den Vorgang und kehrt sofort an den Aufrufer zurück, wobei ein undurchsichtiges, asynchrones Aufgabenhandle zurückgegeben wird, mit dem die Anwendung den Vorgang identifizieren kann. Wenn der Vorgang abgeschlossen ist, werden die Ergebnisse (falls vorhanden) in den vom Aufrufer bereitgestellten Puffer kopiert, und eine Nachricht wird an das Fenster der Anwendung gesendet.
Wenn der asynchrone Vorgang abgeschlossen ist, empfängt das durch den hWnd-Parameter angegebene Anwendungsfenster eine Nachricht im wMsg-Parameter . Der wParam-Parameter enthält das asynchrone Aufgabenhandle, das vom ursprünglichen Funktionsaufruf zurückgegeben wird. Die hohen 16 Bits von lParam enthalten einen beliebigen Fehlercode. Der Fehlercode kann ein beliebiger Fehler sein, der in Winsock2.h definiert ist. Ein Fehlercode von null zeigt den erfolgreichen Abschluss des asynchronen Vorgangs an.
Nach erfolgreicher Fertigstellung enthält der für den ursprünglichen Funktionsaufruf angegebene Puffer eine Protoensstruktur . Um auf die Elemente dieser Struktur zuzugreifen, sollte die ursprüngliche Pufferadresse in einen Protoensstrukturzeiger umgewandelt und nach Bedarf darauf zugegriffen werden.
Wenn der Fehlercode WSAENOBUFS ist, war die Größe des Puffers, der von buflen im ursprünglichen Aufruf angegeben wurde, zu klein, um alle resultierenden Informationen zu enthalten. In diesem Fall enthalten die niedrigen 16 Bits von lParam die Größe des Puffers, der zum Bereitstellen aller erforderlichen Informationen erforderlich ist. Wenn die Anwendung entscheidet, dass die Teildaten unzureichend sind, kann sie den WSAAsyncGetProtoByName-Funktionsaufruf mit einem Puffer erneut ausgeben, der groß genug ist, um alle gewünschten Informationen zu empfangen (d. a. nicht kleiner als die niedrigen 16 Bits von lParam).
Der für diese Funktion angegebene Puffer wird von Windows Sockets verwendet, um eine Protoensstruktur zusammen mit dem Inhalt von Datenbereichen zu erstellen, auf die von Membern derselben Protoentenstruktur verwiesen wird. Um den oben erwähnten WSAENOBUFS-Fehler zu vermeiden, sollte die Anwendung einen Puffer von mindestens MAXGETHOSTSTRUCT-Bytes (wie in Winsock2.h definiert) bereitstellen.
Der Fehlercode und die Pufferlänge sollten mithilfe der Makros WSAGETASYNCERROR und WSAGETASYNCBUFLEN aus dem lParam extrahiert werden, die in Winsock2.h als definiert sind:
#include <windows.h>
#define WSAGETASYNCBUFLEN(lParam) LOWORD(lParam)
#define WSAGETASYNCERROR(lParam) HIWORD(lParam)
Die Verwendung dieser Makros maximiert die Portabilität des Quellcodes für die Anwendung.
Anforderungen
| Anforderung | Wert |
|---|---|
| Unterstützte Mindestversion (Client) | Windows 2000 Professional [nur Desktop-Apps] |
| Unterstützte Mindestversion (Server) | Windows 2000 Server [nur Desktop-Apps] |
| Zielplattform | Windows |
| Kopfzeile | winsock2.h (einschließlich Winsock2.h) |
| Bibliothek | Ws2_32.lib |
| DLL | Ws2_32.dll |