fungsi getpeername (winsock.h)

Artikel
08/27/2023

Fungsi getpeername mengambil alamat peer tempat soket tersambung.

Sintaks

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

Parameter

[in] s

Deskriptor yang mengidentifikasi soket yang terhubung.

[out] name

Struktur SOCKADDR yang menerima alamat serekan.

[in, out] namelen

Penunjuk ke ukuran, dalam byte, dari parameter nama .

Nilai kembali

Jika tidak ada kesalahan yang terjadi, getpeername mengembalikan nol. Jika tidak, nilai SOCKET_ERROR dikembalikan, dan kode kesalahan tertentu dapat diambil dengan memanggil WSAGetLastError.

Kode kesalahan	Makna
WSANOTINITIALISED	Panggilan WSAStartup yang berhasil harus terjadi sebelum menggunakan fungsi ini.
WSAENETDOWN	Subsistem jaringan gagal.
WSAEFAULT	Nama atau parameter namelen tidak berada di bagian ruang alamat pengguna yang valid, atau parameter namelen terlalu kecil.
WSAEINPROGRESS	Pemblokiran panggilan Windows Sockets 1.1 sedang berlangsung, atau penyedia layanan masih memproses fungsi panggilan balik.
WSAENOTCONN	Soket tidak tersambung.
WSAENOTSOCK	Deskriptor bukan soket.

Keterangan

Fungsi getpeername mengambil alamat peer yang terhubung ke soket dan menyimpan alamat dalam struktur SOCKADDR yang diidentifikasi oleh parameter nama . Fungsi ini bekerja dengan keluarga alamat apa pun dan hanya mengembalikan alamat yang terhubung dengan soket. Fungsi getpeername hanya dapat digunakan pada soket yang terhubung.

Untuk soket datagram, hanya alamat serekan yang ditentukan dalam panggilan koneksi sebelumnya yang akan dikembalikan. Alamat apa pun yang ditentukan oleh panggilan sendto sebelumnya tidak akan dikembalikan dengan getpeername.

Saat panggilan, parameter namelen berisi ukuran, dalam byte, dari buffer nama . Saat dikembalikan, parameter namelen berisi ukuran aktual, dalam byte, dari parameter nama yang dikembalikan.

Windows Phone 8: Fungsi ini didukung untuk aplikasi Windows Phone Store di Windows Phone 8 dan yang lebih baru.

Windows 8.1 dan Windows Server 2012 R2: Fungsi ini didukung untuk aplikasi Windows Store di Windows 8.1, Windows Server 2012 R2, dan yang lebih baru.

Persyaratan

Persyaratan	Nilai
Klien minimum yang didukung	Windows 8.1, Windows Vista [aplikasi desktop \| Aplikasi UWP]
Server minimum yang didukung	Windows Server 2003 [aplikasi desktop \| Aplikasi UWP]
Target Platform	Windows
Header	winsock.h (termasuk Winsock2.h)
Pustaka	Ws2_32.lib
DLL	Ws2_32.dll