Fungsi DhcpEnumSubnetElements (dhcpsapi.h)

Fungsi DhcpEnumSubnetElements mengembalikan daftar elemen yang dijumlahkan untuk subnet DHCP tertentu.

Sintaks

DWORD DHCP_API_FUNCTION DhcpEnumSubnetElements(
  [in]      DHCP_CONST WCHAR                 *ServerIpAddress,
  [in]      DHCP_IP_ADDRESS                  SubnetAddress,
  [in]      DHCP_SUBNET_ELEMENT_TYPE         EnumElementType,
  [in, out] DHCP_RESUME_HANDLE               *ResumeHandle,
  [in]      DWORD                            PreferredMaximum,
  [out]     LPDHCP_SUBNET_ELEMENT_INFO_ARRAY *EnumElementInfo,
  [out]     DWORD                            *ElementsRead,
  [out]     DWORD                            *ElementsTotal
);

Parameter

[in] ServerIpAddress

Untai (karakter) Unicode yang menentukan alamat IPv4 server DHCP.

[in] SubnetAddress

DHCP_IP_ADDRESS nilai yang menentukan alamat subnet IPv4 yang elemennya akan dijumlahkan.

[in] EnumElementType

DHCP_SUBNET_ELEMENT_TYPE nilai enumerasi yang menunjukkan jenis elemen subnet untuk dijumlahkan.

[in, out] ResumeHandle

Arahkan ke nilai DHCP_RESUME_HANDLE yang mengidentifikasi operasi enumerasi. Awalnya, nilai ini harus nol, dengan panggilan yang berhasil mengembalikan nilai handel yang digunakan untuk permintaan enumerasi berikutnya. Misalnya, jika PreferredMaximum diatur ke 1000 byte, dan elemen subnet senilai 2000 byte disimpan di server, handel resume dapat digunakan setelah 1000 byte pertama diambil untuk mendapatkan 1000 berikutnya pada panggilan berikutnya, dan sebagainya.

Keberadaan data tambahan yang dapat dijumlahkan ditunjukkan ketika fungsi ini mengembalikan ERROR_MORE_DATA. Jika tidak ada data tambahan yang dapat dijumlahkan yang tersedia di server DHCPv4, ERROR_NO_MORE_ITEMS dikembalikan.

[in] PreferredMaximum

Menentukan jumlah maksimum byte elemen subnet yang disukai untuk dikembalikan. Jika jumlah opsi yang belum dinilai (dalam byte) yang tersisa kurang dari nilai ini, maka jumlah tersebut akan dikembalikan.

Untuk mengambil semua elemen klien subnet untuk kelas pengguna dan vendor default pada tingkat yang ditentukan, atur parameter ini ke 0xFFFFFFFF.

[out] EnumElementInfo

Penunjuk ke penunjuk ke struktur DHCP_SUBNET_ELEMENT_INFO_ARRAY yang berisi daftar enumerasi dari semua elemen yang tersedia untuk subnet yang ditentukan. Jika tidak ada elemen yang tersedia untuk enumerasi, nilai ini akan null.

[out] ElementsRead

Penunjuk ke nilai DWORD yang menentukan jumlah elemen subnet yang dikembalikan dalam EnumElementInfo.

[out] ElementsTotal

Penunjuk ke nilai DWORD yang menentukan jumlah total elemen yang belum dinilai yang tersisa di server untuk subnet yang ditentukan.

Menampilkan nilai

Fungsi ini mengembalikan ERROR_SUCCESS setelah panggilan berhasil. Jika tidak, ia mengembalikan salah satu Kode Kesalahan API Manajemen Server DHCP.

Menampilkan kode Deskripsi
ERROR_DHCP_JET_ERROR
Terjadi kesalahan saat mengakses database server DHCP.
ERROR_MORE_DATA
Ada lebih banyak elemen yang tersedia untuk dijumlahkan.
ERROR_NO_MORE_ITEMS
Tidak ada lagi elemen yang tersisa untuk dijumlahkan.
ERROR_DHCP_SUBNET_NOT_PRESENT
Subnet IPv4 yang ditentukan tidak ada di server DHCP.

Persyaratan

   
Klien minimum yang didukung Tidak ada yang didukung
Server minimum yang didukung Windows 2000 Server [hanya aplikasi desktop]
Target Platform Windows
Header dhcpsapi.h
Pustaka Dhcpsapi.lib
DLL Dhcpsapi.dll

Lihat juga

DHCP_SUBNET_ELEMENT_INFO_ARRAY

DHCP_SUBNET_ELEMENT_TYPE

DhcpEnumSubnetElementsV4

DhcpEnumSubnetElementsV5