Funzione ClusterNodeEnum (clusapi.h)

Articolo
08/22/2023

Enumera le interfacce di rete o i gruppi installati in un nodo, restituendo il nome di ogni chiamata. Il tipo PCLUSAPI_CLUSTER_NODE_ENUM definisce un puntatore a questa funzione.

Sintassi

DWORD ClusterNodeEnum(
  [in]      HNODEENUM hNodeEnum,
  [in]      DWORD     dwIndex,
  [out]     LPDWORD   lpdwType,
  [out]     LPWSTR    lpszName,
  [in, out] LPDWORD   lpcchName
);

Parametri

[in] hNodeEnum

Handle per un oggetto di enumerazione esistente originariamente restituito dalla funzione ClusterNodeOpenEnum .

[in] dwIndex

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

[out] lpdwType

Puntatore al tipo di oggetto restituito. Il valore seguente dell'enumerazione CLUSTER_NODE_ENUM viene restituito con ogni chiamata.

CLUSTER_NODE_ENUM_NETINTERFACES (1)

L'oggetto è un'interfaccia di rete.

CLUSTER_NODE_ENUM_GROUPS (0x00000002)

L'oggetto è un gruppo di cluster.

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

[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 numero 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

Per usare ClusterNodeEnum, le applicazioni aprono prima di tutto un handle di enumerazione del nodo chiamando ClusterNodeOpenEnum con il parametro dwType impostato su CLUSTER_NODE_ENUM_NETINTERFACES. Per altre informazioni, vedere Enumerazione degli oggetti.

Si noti che il parametro lpcchName fa riferimento a un conteggio di caratteri e non a un conteggio di byte e che la dimensione restituita non include 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

Requisito	Valore
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