Função getpeername (winsock2.h)

Artigo
03/13/2024

A função getpeername recupera o endereço do par ao qual um soquete está conectado.

Sintaxe

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

Parâmetros

[in] s

Um descritor que identifica um soquete conectado.

[out] name

A estrutura SOCKADDR que recebe o endereço do par.

[in, out] namelen

Um ponteiro para o tamanho, em bytes, do parâmetro name .

Retornar valor

Se nenhum erro ocorrer, getpeername retornará zero. Caso contrário, um valor de SOCKET_ERROR é retornado e um código de erro específico pode ser recuperado chamando WSAGetLastError.

Código do erro	Significado
WSANOTINITIALISED	Uma chamada WSAStartup bem-sucedida deve ocorrer antes de usar essa função.
WSAENETDOWN	O subsistema de rede falhou.
WSAEFAULT	O nome ou o parâmetro namelen não está em uma parte válida do espaço de endereço do usuário ou o parâmetro namelen é muito pequeno.
WSAEINPROGRESS	Uma chamada do Windows Sockets 1.1 de bloqueio está em andamento ou o provedor de serviços ainda está processando uma função de retorno de chamada.
WSAENOTCONN	O soquete não está conectado.
WSAENOTSOCK	O descritor não é um soquete.

Comentários

A função getpeername recupera o endereço do par conectado aos soquetes e armazena o endereço na estrutura SOCKADDR identificada pelo parâmetro name . Essa função funciona com qualquer família de endereços e simplesmente retorna o endereço ao qual o soquete está conectado. A função getpeername só pode ser usada em um soquete conectado.

Para soquetes de datagrama, somente o endereço de um par especificado em uma chamada de conexão anterior será retornado. Qualquer endereço especificado por uma chamada sendto anterior não será retornado por getpeername.

Ao chamar, o parâmetro namelen contém o tamanho, em bytes, do buffer de nome . No retorno, o parâmetro namelen contém o tamanho real, em bytes, do parâmetro name retornado.

Windows Phone 8: essa função tem suporte para aplicativos da Windows Phone Store no Windows Phone 8 e posterior.

Windows 8.1 e Windows Server 2012 R2: essa função tem suporte para aplicativos da Windows Store em Windows 8.1, Windows Server 2012 R2 e posteriores.

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows 8.1, Windows Vista [aplicativos da área de trabalho \| Aplicativos UWP]
Servidor mínimo com suporte	Windows Server 2003 [aplicativos da área de trabalho \| Aplicativos UWP]
Plataforma de Destino	Windows
Cabeçalho	winsock2.h (inclua Winsock2.h)
Biblioteca	Ws2_32.lib
DLL	Ws2_32.dll