Fungsi ClusterEnum (clusapi.h)

Artikel
03/08/2023

Menghitung objek kluster dalam kluster, mengembalikan nama satu objek dengan setiap panggilan. Jenis PCLUSAPI_CLUSTER_ENUM menentukan penunjuk ke fungsi ini.

Sintaks

DWORD ClusterEnum(
  [in]      HCLUSENUM hEnum,
  [in]      DWORD     dwIndex,
  [out]     LPDWORD   lpdwType,
  [out]     LPWSTR    lpszName,
  [in, out] LPDWORD   lpcchName
);

Parameter

[in] hEnum

Handel enumerasi kluster yang dikembalikan oleh fungsi ClusterOpenEnum .

[in] dwIndex

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

[out] lpdwType

Penunjuk ke jenis objek yang dikembalikan. Salah satu nilai enumerasi CLUSTER_ENUM berikut dikembalikan dengan setiap panggilan.

CLUSTER_ENUM_NODE (1 (0x1))

Menghitung simpul dalam kluster.

CLUSTER_ENUM_RESTYPE (2 (0x2))

Menghitung jenis sumber daya dalam kluster.

CLUSTER_ENUM_RESOURCE (4 (0x4))

Menghitung sumber daya dalam kluster.

CLUSTER_ENUM_GROUP (8 (0x8))

Menghitung grup dalam kluster.

CLUSTER_ENUM_NETWORK (16 (0x10))

Menghitung jaringan dalam kluster.

CLUSTER_ENUM_NETINTERFACE (32 (0x20))

Menghitung antarmuka jaringan dalam kluster.

CLUSTER_ENUM_SHARED_VOLUME_RESOURCE (1073741824 (0x40000000))

Menghitung volume bersama kluster yang digunakan oleh kluster.

Catatan Tidak seperti kebanyakan bitmask enumerasi lainnya, nilai ini harus digunakan sendiri. Jangan gunakan operator OR untuk menggabungkannya dengan bitmasks lainnya.

Windows Server 2008: Nilai CLUSTER_ENUM_SHARED_VOLUME_RESOURCE tidak didukung sebelum Windows Server 2008 R2.

CLUSTER_ENUM_INTERNAL_NETWORK (2147483648 (0x80000000))

Menghitung jaringan yang digunakan oleh kluster untuk komunikasi internal. Jaringan dijumlahkan dalam urutan prioritas tertinggi hingga terendah seperti yang ditetapkan oleh fungsi SetClusterNetworkPriorityOrder .

Catatan Tidak seperti kebanyakan bitmask enumerasi lainnya, nilai ini harus digunakan sendiri. Jangan gunakan operator OR untuk menggabungkannya dengan bitmasks lainnya.

CLUSTER_ENUM_ALL ((CLUSTER_ENUM_NODE | CLUSTER_ENUM_RESTYPE | CLUSTER_ENUM_RESOURCE | CLUSTER_ENUM_GROUP | CLUSTER_ENUM_NETWORK | CLUSTER_ENUM_NETINTERFACE))

Menghitung semua objek kluster.

[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_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.
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.

Keterangan

Fungsi ClusterEnum biasanya digunakan untuk melakukan iterasi melalui kumpulan objek kluster dari satu atau beberapa jenis. Jika, misalnya, aplikasi ingin menghitung semua simpul dalam kluster, aplikasi memanggil ClusterOpenEnum untuk membuka enumerator kluster yang dapat memproses simpul. Parameter dwType diatur ke CLUSTER_ENUM_NODE untuk menentukan simpul sebagai jenis objek yang akan dijumlahkan. Jika aplikasi menghitung grup selain simpul, parameter dwType diatur ke CLUSTER_ENUM_NODE | CLUSTER_ENUM_GROUP. Dengan handel yang dikembalikan ClusterOpenEnum , aplikasi memanggil ClusterEnum 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


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

ClusterCloseEnum

ClusterOpenEnum

SetClusterNetworkPriorityOrder

Bagikan melalui