Fungsi GetUdpTable (iphlpapi.h)

Artikel
08/24/2023

Fungsi GetUdpTable mengambil tabel pendengar Protokol Datagram Pengguna (UDP) IPv4.

Sintaks

IPHLPAPI_DLL_LINKAGE ULONG GetUdpTable(
  [out]     PMIB_UDPTABLE UdpTable,
  [in, out] PULONG        SizePointer,
  [in]      BOOL          Order
);

Parameter

[out] UdpTable

Penunjuk ke buffer yang menerima tabel pendengar UDP IPv4 sebagai struktur MIB_UDPTABLE .

[in, out] SizePointer

Pada input, menentukan ukuran dalam byte buffer yang diacu oleh parameter UdpTable .

Pada output, jika buffer tidak cukup besar untuk menahan tabel pendengar yang dikembalikan, fungsi mengatur parameter ini sama dengan ukuran buffer yang diperlukan dalam byte.

Pada Windows SDK yang dirilis untuk Windows Vista dan yang lebih baru, jenis data untuk parameter ini diubah menjadi PULONG yang setara dengan PDWORD.

[in] Order

Nilai Boolean yang menentukan apakah tabel pendengar UDP yang dikembalikan harus diurutkan. Jika parameter ini TRUE, tabel diurutkan dalam urutan:

Alamat IP lokal
Port lokal

Nilai kembali

Jika fungsi berhasil, nilai yang dikembalikan NO_ERROR.

Jika fungsi gagal, nilai yang dikembalikan adalah salah satu kode kesalahan berikut.

Menampilkan kode	Deskripsi
ERROR_INSUFFICIENT_BUFFER	Buffer yang ditujukkan oleh parameter pUdpTable tidak cukup besar. Ukuran yang diperlukan dikembalikan dalam variabel ULONG yang diarahkan oleh parameter pdwSize . Kesalahan ini juga dikembalikan jika parameter pUdpTable adalah NULL.
ERROR_INVALID_PARAMETER	Parameter pdwSizeadalah NULL, atau GetUdpTable tidak dapat menulis ke memori yang diarahkan oleh parameter pdwSize .
ERROR_NOT_SUPPORTED	Fungsi ini tidak didukung pada sistem operasi yang digunakan pada sistem lokal.
Lainnya	Gunakan FormatMessage untuk mendapatkan string pesan untuk kesalahan yang dikembalikan.

Keterangan

Pada Windows SDK yang dirilis untuk Windows Vista dan yang lebih baru, nilai pengembalian dari fungsi GetUdpTable diubah menjadi jenis data ULONG yang setara dengan DWORD.

Persyaratan


Klien minimum yang didukung	Windows 2000 Professional [aplikasi desktop \| Aplikasi UWP]
Server minimum yang didukung	Windows 2000 Server [aplikasi desktop \| Aplikasi UWP]
Target Platform	Windows
Header	iphlpapi.h
Pustaka	Iphlpapi.lib
DLL	Iphlpapi.dll