WSAAsyncGetServByName-Funktion (winsock.h)

Die WSAAsyncGetServByName-Funktion ruft asynchron Dienstinformationen ab, die einem Dienstnamen und Port entsprechen.

Syntax

HANDLE WSAAsyncGetServByName(
  [in]  HWND       hWnd,
  [in]  u_int      wMsg,
  [in]  const char *name,
  [in]  const char *proto,
  [out] char       *buf,
  [in]  int        buflen
);

Parameter

[in] hWnd

Handle des Fensters, das eine Nachricht erhalten soll, wenn die asynchrone Anforderung abgeschlossen ist.

[in] wMsg

Nachricht, die empfangen werden soll, wenn die asynchrone Anforderung abgeschlossen ist.

[in] name

Zeiger auf einen Dienstnamen mit NULL-Beendigung.

[in] proto

Zeiger auf einen Protokollnamen. Dies kann NULL sein. In diesem Fall sucht WSAAsyncGetServByName nach dem ersten Diensteintrag, für den s_name oder einer der s_aliases mit dem angegebenen Namen übereinstimmt. Andernfalls entspricht WSAAsyncGetServByName sowohl name als auch proto.

[out] buf

Zeiger auf den Datenbereich, um die Serventdaten zu empfangen. Der Datenbereich muss größer als die Größe einer Serventstruktur sein, da der Datenbereich von Windows Sockets verwendet wird, um eine Serventstruktur und alle Daten zu enthalten, auf die von Mitgliedern der Serventstruktur verwiesen wird. Ein Puffer von MAXGETHOSTSTRUCT-Bytes wird empfohlen.

[in] 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 WSAAsyncGetServByName einen nonzero-Wert vom Typ HANDLE zurück, der das asynchrone Aufgabenhandle für die Anforderung ist (nicht zu verwechseln mit einem Windows HTASK). 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 WSAAsyncServByName einen Nullwert zurück, und eine bestimmte Fehlernummer kann durch Aufrufen von WSAGetLastError abgerufen werden.

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.

Die folgenden Fehler können zum Zeitpunkt des Funktionsaufrufs auftreten und zeigen an, dass der asynchrone Vorgang nicht initiiert werden konnte.

Hinweise

Die WSAAsyncGetServByName-Funktion ist eine asynchrone Version von getservbyname und wird verwendet, um Dienstinformationen abzurufen, die einem Dienstnamen entsprechen. 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 puffer, der für den ursprünglichen Funktionsaufruf angegeben wurde, eine Serventstruktur . Um auf die Elemente dieser Struktur zuzugreifen, sollte die ursprüngliche Pufferadresse in einen Dienststrukturzeiger 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 WSAAsyncGetServByName-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 Serventstruktur zusammen mit dem Inhalt von Datenbereichen zu erstellen, auf die von Membern derselben Serventstruktur verwiesen wird. Um den WSAENOBUFS-Fehler zu vermeiden, sollte die Anwendung einen Puffer von mindestens MAXGETHOSTSTRUCT-Bytes bereitstellen (wie in Winsock2.h definiert).

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

Weitere Informationen

WSACancelAsyncRequest

Winsock-Funktionen

Winsock-Referenz

getservbyname