Fungsi ClusterNetworkEnum (clusapi.h)

Menghitung objek kluster pada jaringan, mengembalikan nama satu objek dengan setiap panggilan. Jenis PCLUSAPI_CLUSTER_NETWORK_ENUM mendefinisikan penunjuk ke fungsi ini.

Sintaks

DWORD ClusterNetworkEnum(
  [in]      HNETWORKENUM hNetworkEnum,
  [in]      DWORD        dwIndex,
  [out]     LPDWORD      lpdwType,
  [out]     LPWSTR       lpszName,
  [in, out] LPDWORD      lpcchName
);

Parameter

[in] hNetworkEnum

Handel ke objek enumerasi yang ada awalnya dikembalikan oleh fungsi ClusterNetworkOpenEnum .

[in] dwIndex

Indeks yang digunakan untuk mengidentifikasi entri berikutnya yang akan dijumlahkan. Parameter ini harus nol untuk panggilan pertama ke ClusterNetworkEnum dan kemudian dinaikkan untuk panggilan berikutnya.

[out] lpdwType

Penunjuk ke jenis objek yang dikembalikan. Nilai enumerasi CLUSTER_NETWORK_ENUM berikut dikembalikan dengan setiap panggilan.

CLUSTER_NETWORK_ENUM_NETINTERFACES (1)

Objek adalah antarmuka jaringan.

[out] lpszName

Penunjuk ke string Unicode yang dihentikan null yang berisi nama objek yang dikembalikan.

[in, out] lpcchName

Penunjuk ke ukuran buffer lpszName sebagai hitungan karakter. Pada input, tentukan jumlah maksimum karakter yang dapat ditahan buffer, termasuk NULL yang mengakhiri. Pada output, menentukan jumlah karakter dalam nama yang dihasilkan, tidak termasuk NULL yang mengakhiri.

Nilai kembali

Fungsi mengembalikan salah satu nilai berikut.

Mengembalikan kode/nilai	Deskripsi
ERROR_SUCCESS 0	Operasi berhasil diselesaikan.
ERROR_MORE_DATA 234 (0xEA)	Lebih banyak data tersedia. Nilai ini dikembalikan jika buffer yang ditunjukkan oleh lpszName tidak cukup besar untuk menahan hasilnya. Parameter lpcchName mengembalikan jumlah karakter dalam hasil, tidak termasuk NULL yang mengakhiri.
ERROR_NO_MORE_ITEMS 259 (0x103)	Tidak ada lagi data yang tersedia. Nilai ini dikembalikan jika tidak ada lagi objek dari jenis yang diminta untuk dikembalikan.

Keterangan

Fungsi ClusterNetworkEnum biasanya digunakan untuk melakukan iterasi melalui kumpulan objek dari satu atau beberapa jenis milik objek jaringan. Jika, misalnya, aplikasi ingin menghitung semua objek antarmuka jaringan di jaringan, aplikasi memanggil ClusterNetworkOpenEnum untuk membuka enumerator jaringan yang dapat memproses objek antarmuka jaringan. Parameter dwType diatur ke CLUSTER_NETWORK_ENUM_NETINTERFACES untuk menentukan antarmuka jaringan sebagai jenis objek yang akan dijumlahkan. Dengan handel yang dikembalikan ClusterNetworkOpenEnum , aplikasi memanggil ClusterNetworkEnum berulang kali untuk mengambil setiap objek. Parameter lpdwType menunjuk ke jenis objek yang diambil.

Perhatikan bahwa lpcchName mengacu pada hitungan karakter dan bukan hitungan byte, dan bahwa ukuran yang dikembalikan tidak menyertakan NULL yang mengakhiri dalam hitungan. Untuk informasi selengkapnya tentang buffer ukuran, lihat Konvensi Ukuran Data.

Contoh

Lihat Menghitung Objek.

Persyaratan

Persyaratan	Nilai
Klien minimum yang didukung	Tidak ada yang didukung
Server minimum yang didukung	Pusat Data Windows Server 2008 Enterprise, Windows Server 2008
Target Platform	Windows
Header	clusapi.h
Pustaka	ClusAPI.lib
DLL	ClusAPI.dll

Lihat juga

CLUSTER_NETWORK_ENUM

Fungsi Manajemen Jaringan Kluster

ClusterNetworkCloseEnum

ClusterNetworkOpenEnum