getpeername-Funktion (winsock2.h)

Artikel
03/04/2024

Die getpeername-Funktion ruft die Adresse des Peers ab, mit dem ein Socket verbunden ist.

Syntax

int WSAAPI getpeername(
  [in]      SOCKET   s,
  [out]     sockaddr *name,
  [in, out] int      *namelen
);

Parameter

[in] s

Ein Deskriptor, der einen verbundenen Socket identifiziert.

[out] name

Die SOCKADDR-Struktur , die die Adresse des Peers empfängt.

[in, out] namelen

Ein Zeiger auf die Größe des namensparameters in Bytes.

Rückgabewert

Wenn kein Fehler auftritt, gibt getpeername null zurück. Andernfalls wird der Wert SOCKET_ERROR zurückgegeben, und ein bestimmter Fehlercode kann durch Aufrufen von WSAGetLastError abgerufen werden.

Fehlercode	Bedeutung
WSANOTINITIALISIERT	Vor der Verwendung dieser Funktion muss ein erfolgreicher WSAStartup-Aufruf erfolgen.
WSAENETDOWN	Beim Netzwerksubsystem ist ein Fehler aufgetreten.
WSAEFAULT	Der Name oder der namelen-Parameter befindet sich nicht in einem gültigen Teil des Benutzeradressraums, oder der namelen-Parameter ist zu klein.
WSAEINPROGRESS	Ein blockierter Windows Sockets 1.1-Aufruf wird ausgeführt, oder der Dienstanbieter verarbeitet weiterhin eine Rückruffunktion.
WSAENOTCONN	Der Socket ist nicht verbunden.
WSAENOTSOCK	Der Deskriptor ist kein Socket.

Hinweise

Die getpeername-Funktion ruft die Adresse des Peers ab, der mit den Sockets verbunden ist, und speichert die Adresse in der SOCKADDR-Struktur , die durch den name-Parameter identifiziert wird. Diese Funktion funktioniert mit jeder Adressfamilie und gibt einfach die Adresse zurück, mit der der Socket verbunden ist. Die getpeername-Funktion kann nur für einen verbundenen Socket verwendet werden.

Bei Datagrammsockets wird nur die Adresse eines Peers zurückgegeben, die in einem vorherigen Verbindungsaufruf angegeben wurde. Jede adresse, die durch einen vorherigen sendto-Aufruf angegeben wurde, wird von getpeername nicht zurückgegeben.

Beim Aufruf enthält der namelen-Parameter die Größe des Namenspuffers in Bytes. Bei der Rückgabe enthält der namelen-Parameter die tatsächliche Größe des zurückgegebenen Namensparameters in Bytes.

Windows Phone 8: Diese Funktion wird für Windows Phone Store-Apps auf Windows Phone 8 und höher unterstützt.

Windows 8.1 und Windows Server 2012 R2: Diese Funktion wird für Windows Store-Apps auf Windows 8.1, Windows Server 2012 R2 und höher unterstützt.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows 8.1, Windows Vista [Desktop-Apps \| UWP-Apps]
Unterstützte Mindestversion (Server)	Windows Server 2003 [Desktop-Apps \| UWP-Apps]
Zielplattform	Windows
Kopfzeile	winsock2.h (einschließlich Winsock2.h)
Bibliothek	Ws2_32.lib
DLL	Ws2_32.dll