fonction getpeername (winsock.h)

Article
03/04/2024

La fonction getpeername récupère l’adresse de l’homologue auquel un socket est connecté.

Syntaxe

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

Paramètres

[in] s

Descripteur identifiant un socket connecté.

[out] name

Structure SOCKADDR qui reçoit l’adresse de l’homologue.

[in, out] namelen

Pointeur vers la taille, en octets, du paramètre name .

Valeur retournée

Si aucune erreur ne se produit, getpeername retourne zéro. Sinon, une valeur de SOCKET_ERROR est retournée et un code d’erreur spécifique peut être récupéré en appelant WSAGetLastError.

Code d'erreur	Signification
WSANOTINITIALISED	Un appel WSAStartup réussi doit se produire avant d’utiliser cette fonction.
WSAENETDOWN	Le sous-système réseau a échoué.
WSAEFAULT	Le nom ou le paramètre namelen ne se trouve pas dans une partie valide de l’espace d’adressage utilisateur, ou le paramètre namelen est trop petit.
WSAEINPROGRESS	Un appel bloquant Windows Sockets 1.1 est en cours ou le fournisseur de services traite toujours une fonction de rappel.
WSAENOTCONN	Le socket n'est pas connecté.
WSAENOTSOCK	Le descripteur n’est pas un socket.

Remarques

La fonction getpeername récupère l’adresse de l’homologue connecté aux sockets et stocke l’adresse dans la structure SOCKADDR identifiée par le paramètre name . Cette fonction fonctionne avec n’importe quelle famille d’adresses et retourne simplement l’adresse à laquelle le socket est connecté. La fonction getpeername ne peut être utilisée que sur un socket connecté.

Pour les sockets de datagramme, seule l’adresse d’un homologue spécifié dans un appel de connexion précédent sera retournée. Toute adresse spécifiée par un appel sendto précédent ne sera pas retournée par getpeername.

À l’appel, le paramètre namelen contient la taille, en octets, de la mémoire tampon de noms . En retour, le paramètre namelen contient la taille réelle, en octets, du paramètre name retourné.

Windows Phone 8 : cette fonction est prise en charge pour les applications du Store Windows Phone Windows Phone 8 et versions ultérieures.

Windows 8.1 et Windows Server 2012 R2 : cette fonction est prise en charge pour les applications du Windows Store sur Windows 8.1, Windows Server 2012 R2 et versions ultérieures.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows 8.1, Windows Vista [applications de bureau \| Applications UWP]
Serveur minimal pris en charge	Windows Server 2003 [applications de bureau \| applications UWP]
Plateforme cible	Windows
En-tête	winsock.h (inclure Winsock2.h)
Bibliothèque	Ws2_32.lib
DLL	Ws2_32.dll