Funzione ClusterNetworkEnum (clusapi.h)
Enumera gli oggetti cluster in una rete, restituendo il nome di un oggetto con ogni chiamata. Il tipo PCLUSAPI_CLUSTER_NETWORK_ENUM definisce un puntatore a questa funzione.
Sintassi
DWORD ClusterNetworkEnum(
[in] HNETWORKENUM hNetworkEnum,
[in] DWORD dwIndex,
[out] LPDWORD lpdwType,
[out] LPWSTR lpszName,
[in, out] LPDWORD lpcchName
);
Parametri
[in] hNetworkEnum
Handle per un oggetto di enumerazione esistente originariamente restituito dalla funzione ClusterNetworkOpenEnum .
[in] dwIndex
Indice utilizzato per identificare la voce successiva da enumerare. Questo parametro deve essere zero per la prima chiamata a ClusterNetworkEnum e quindi incrementato per le chiamate successive.
[out] lpdwType
Puntatore al tipo di oggetto restituito. Il valore seguente dell'enumerazione CLUSTER_NETWORK_ENUM viene restituito con ogni chiamata.
CLUSTER_NETWORK_ENUM_NETINTERFACES (1)
L'oggetto è un'interfaccia di rete.
[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 |
|---|---|
|
Operazione riuscita. |
|
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. |
|
Dati disponibili esauriti. Questo valore viene restituito se non sono presenti altri oggetti del tipo richiesto da restituire. |
Commenti
La funzione ClusterNetworkEnum viene in genere usata per scorrere una raccolta di oggetti di uno o più tipi appartenenti a un oggetto di rete. Se, ad esempio, un'applicazione vuole enumerare tutti gli oggetti dell'interfaccia di rete in una rete, chiama ClusterNetworkOpenEnum per aprire un enumeratore di rete in grado di elaborare oggetti dell'interfaccia di rete. Il parametro dwType è impostato su CLUSTER_NETWORK_ENUM_NETINTERFACES per specificare le interfacce di rete come tipo di oggetto da enumerare. Con l'handle restituito da ClusterNetworkOpenEnum , l'applicazione chiama ripetutamente ClusterNetworkEnum 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
| 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 |