Fungsi WSADeleteSocketPeerTargetName (ws2tcpip.h)

Artikel
03/04/2024

Fungsi WSADeleteSocketPeerTargetName menghapus hubungan antara nama target serekan dan alamat IP untuk soket. Setelah pengembalian berhasil, tidak akan ada hubungan di masa depan antara alamat IP dan nama target.

Sintaks

INT WSAAPI WSADeleteSocketPeerTargetName(
  [in]           SOCKET                             Socket,
  [in]           const sockaddr                     *PeerAddr,
  [in]           ULONG                              PeerAddrLen,
  [in, optional] LPWSAOVERLAPPED                    Overlapped,
  [in, optional] LPWSAOVERLAPPED_COMPLETION_ROUTINE CompletionRoutine
);

Parameter

[in] Socket

Deskriptor yang mengidentifikasi soket tempat nama target peer dihapus.

[in] PeerAddr

Alamat IP peer yang nama targetnya sedang dihapus.

[in] PeerAddrLen

Ukuran, dalam byte, dari parameter PeerAddr .

[in, optional] Overlapped

Penunjuk ke struktur WSAOVERLAPPED . Parameter ini diabaikan untuk soket yang tidak tumpang tindih.

[in, optional] CompletionRoutine

Penunjuk ke rutinitas penyelesaian yang dipanggil ketika operasi telah selesai. Parameter ini diabaikan untuk soket yang tidak tumpang tindih.

Mengembalikan nilai

Jika fungsi berhasil, nilai yang dikembalikan adalah 0. Jika tidak, nilai SOCKET_ERROR dikembalikan, dan kode kesalahan tertentu dapat diambil dengan memanggil WSAGetLastError.

Beberapa kemungkinan kode kesalahan tercantum di bawah ini.

Kode kesalahan	Makna
WSAEAFNOSUPPORT	Keluarga alamat yang ditentukan tidak didukung.
WSAEFAULT	Sistem mendeteksi penunjuk alamat yang tidak valid dalam mencoba menggunakan argumen pointer panggilan. Kesalahan ini dikembalikan jika parameter PeerAddr adalah penunjuk NULL .
WSAEINVAL	Parameter yang tidak valid diteruskan. Kesalahan ini dikembalikan jika soket yang diteruskan dalam parameter Soket tidak dibuat dengan keluarga alamat AF_INET atau AF_INET6 dan jenis soket SOCK_DGRAM atau SOCK_STREAM.
WSAEMSGSIZE	Buffer yang dilewati terlalu kecil.
WSAENOTSOCK	Deskriptor yang diteruskan dalam parameter Soket bukan soket yang valid.

Keterangan

Fungsi WSADeleteSocketPeerTargetName menyediakan metode untuk menghapus hubungan antara nama target serekan dan alamat IP untuk soket. Fungsi ini digunakan untuk menghapus nama target serekan yang sebelumnya diatur dengan fungsi WSASetSocketPeerTargetName . Setelah fungsi WSADeleteSocketPeerTargetName kembali, tidak ada autentikasi di masa mendatang ke alamat IP yang akan menggunakan nama target yang ditentukan sebelumnya. Fungsi ini terutama dirancang untuk digunakan oleh klien tanpa koneksi (misalnya, soket yang dibuat dengan jenis yang diatur ke SOCK_DGRAM atau protokol yang diatur ke IPPROTO_UDP) setelah mereka menghentikan koneksi dengan alamat IP yang terkait dengan nama target serekan. Untuk klien berorientasi koneksi (misalnya, soket yang dibuat dengan jenis diatur ke SOCK_STREAM atau protokol diatur ke IPPROTO_TCP), fungsi ini tidak boleh dipanggil.

Fungsi WSADeleteSocketPeerTargetName menyederhanakan harus memanggil fungsi WSAIoctl dengan parameter dwIoControlCode yang diatur ke SIO_DELETE_PEER_TARGET_NAME.

Kesalahan akan dikembalikan jika kondisi berikut tidak terpenuhi.

Keluarga alamat parameter Soket harus AF_INET atau AF_INET6.
Jenis soket harus SOCK_STREAM atau SOCK_DGRAM.

Persyaratan

Persyaratan	Nilai
Klien minimum yang didukung	Windows Vista [hanya aplikasi desktop]
Server minimum yang didukung	Windows Server 2008 [hanya aplikasi desktop]
Target Platform	Windows
Header	ws2tcpip.h
Pustaka	Fwpuclnt.lib
DLL	Fwpuclnt.dll