Funzione ClusterEnum (clusapi.h)

Articolo
03/08/2023

Enumera gli oggetti cluster in un cluster, restituendo il nome di un oggetto con ogni chiamata. Il tipo PCLUSAPI_CLUSTER_ENUM definisce un puntatore a questa funzione.

Sintassi

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

Parametri

[in] hEnum

Handle di enumerazione cluster restituito dalla funzione ClusterOpenEnum .

[in] dwIndex

Indice utilizzato per identificare la voce successiva da enumerare. Questo parametro deve essere zero per la prima chiamata a ClusterEnum e quindi incrementato per le chiamate successive.

[out] lpdwType

Puntatore al tipo di oggetto restituito. Uno dei valori seguenti dell'enumerazione CLUSTER_ENUM viene restituito con ogni chiamata.

CLUSTER_ENUM_NODE (1 (0x1))

Enumera i nodi nel cluster.

CLUSTER_ENUM_RESTYPE (2 (0x2))

Enumera i tipi di risorsa nel cluster.

CLUSTER_ENUM_RESOURCE (4 (0x4))

Enumera le risorse nel cluster.

CLUSTER_ENUM_GROUP (8 (0x8))

Enumera i gruppi nel cluster.

CLUSTER_ENUM_NETWORK (16 (0x10))

Enumera le reti nel cluster.

CLUSTER_ENUM_NETINTERFACE (32 (0x20))

Enumera le interfacce di rete nel cluster.

CLUSTER_ENUM_SHARED_VOLUME_RESOURCE (1073741824 (0x40000000))

Enumera i volumi condivisi del cluster usati dal cluster.

Nota A differenza della maggior parte delle altre maschera di bit di enumerazione, questo valore deve essere usato da solo. Non usare l'operatore OR per combinarlo con altre maschera di bit.

Windows Server 2008: Il valore CLUSTER_ENUM_SHARED_VOLUME_RESOURCE non è supportato prima di Windows Server 2008 R2.

CLUSTER_ENUM_INTERNAL_NETWORK (2147483648 (0x80000000))

Enumera le reti usate dal cluster per la comunicazione interna. Le reti vengono enumerate in ordine di priorità più alta alla più bassa, come stabilito dalla funzione SetClusterNetworkPriorityOrder .

Nota A differenza della maggior parte delle altre maschera di bit di enumerazione, questo valore deve essere usato da solo. Non usare l'operatore OR per combinarlo con altre maschera di bit.

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

Enumera tutti gli oggetti cluster.

[out] lpszName

Puntatore a una stringa Unicode con terminazione Null contenente il nome dell'oggetto restituito.

[in, out] lpcchName

Puntatore alla dimensione del buffer lpszName come conteggio di caratteri. In input, specificare il numero massimo di caratteri che il buffer può contenere, incluso il valore NULL di terminazione. Nell'output specifica il numero di caratteri nel nome risultante, escluso il valore NULL di terminazione.

Valore restituito

La funzione restituisce uno dei valori seguenti.

Codice/valore restituito	Descrizione
ERROR_SUCCESS 0	Operazione riuscita.
ERROR_NO_MORE_ITEMS 259 (0x103)	Dati disponibili esauriti. Questo valore viene restituito se non sono presenti altri oggetti del tipo richiesto da restituire.
ERROR_MORE_DATA 234 (0xEA)	sono disponibili più dati. Questo valore viene restituito se il buffer a cui punta lpszName non è sufficientemente grande da contenere il risultato. Il parametro lpcchName restituisce il numero di caratteri nel risultato, escluso il valore NULL di terminazione.

Commenti

La funzione ClusterEnum viene in genere usata per scorrere una raccolta di oggetti cluster di uno o più tipi. Se, ad esempio, un'applicazione vuole enumerare tutti i nodi in un cluster, chiama ClusterOpenEnum per aprire un enumeratore cluster in grado di elaborare i nodi. Il parametro dwType è impostato su CLUSTER_ENUM_NODE per specificare nodi come tipo di oggetto da enumerare. Se l'applicazione enumera gruppi oltre ai nodi, il parametro dwType viene impostato su CLUSTER_ENUM_NODE | CLUSTER_ENUM_GROUP. Con l'handle restituito da ClusterOpenEnum , l'applicazione chiama ripetutamente ClusterEnum per recuperare ognuno degli oggetti. Il parametro lpdwType punta al tipo di oggetto recuperato.

Si noti che lpcchName fa riferimento a un conteggio di caratteri e non a un conteggio di byte e che le dimensioni restituite non includono il valore NULL di terminazione nel conteggio. Per altre informazioni sul ridimensionamento dei buffer, vedere Convenzioni delle dimensioni dei dati.

Esempio

Vedere Enumerazione degli oggetti.

Requisiti


Client minimo supportato	Nessuno supportato
Server minimo supportato	Windows Server 2008 Enterprise, Windows Server 2008 Datacenter
Piattaforma di destinazione	Windows
Intestazione	clusapi.h
Libreria	ClusAPI.lib
DLL	ClusAPI.dll

Vedi anche

ClusterCloseEnum

ClusterOpenEnum

SetClusterNetworkPriorityOrder

Share via