Funzione ClusterControl (clusapi.h)
Avvia un'operazione che influisce su un cluster. L'operazione eseguita dipende dal codice di controllo passato al parametro dwControlCode .
Sintassi
DWORD ClusterControl(
[in] HCLUSTER hCluster,
[in, optional] HNODE hHostNode,
[in] DWORD dwControlCode,
[in, optional] LPVOID lpInBuffer,
[in] DWORD nInBufferSize,
[out, optional] LPVOID lpOutBuffer,
[in] DWORD nOutBufferSize,
[out, optional] LPDWORD lpBytesReturned
);
Parametri
[in] hCluster
Gestire il cluster da interessare.
[in, optional] hHostNode
Se non NULL, gestire il nodo per eseguire l'operazione rappresentata dal codice di controllo. Se NULL, il nodo locale esegue l'operazione. Se si specifica hHostNode , è facoltativo.
[in] dwControlCode
Codice di controllo del cluster dall'enumerazione CLUSCTL_CLUSTER_CODES che specifica l'operazione da eseguire. Per la sintassi associata a un codice di controllo, vedere Architettura del codice di controllo e gli argomenti seguenti:
- CLUSCTL_CLUSTER_CHECK_VOTER_DOWN
- CLUSCTL_CLUSTER_CHECK_VOTER_EVICT
- CLUSCTL_CLUSTER_CLEAR_NODE_CONNECTION_INFO
- CLUSCTL_CLUSTER_ENUM_COMMON_PROPERTIES
- CLUSCTL_CLUSTER_ENUM_PRIVATE_PROPERTIES
- CLUSCTL_CLUSTER_GET_COMMON_PROPERTIES
- CLUSCTL_CLUSTER_GET_FQDN
- CLUSCTL_CLUSTER_GET_COMMON_PROPERTY_FMTS
- CLUSCTL_CLUSTER_GET_PRIVATE_PROPERTIES
- CLUSCTL_CLUSTER_GET_PRIVATE_PROPERTY_FMTS
- CLUSCTL_CLUSTER_GET_RO_COMMON_PROPERTIES
- CLUSCTL_CLUSTER_GET_RO_PRIVATE_PROPERTIES
- CLUSCTL_CLUSTER_GET_SHARED_VOLUME_ID
- CLUSCTL_CLUSTER_SET_COMMON_PROPERTIES
- CLUSCTL_CLUSTER_SET_PRIVATE_PROPERTIES
- CLUSCTL_CLUSTER_SHUTDOWN
- CLUSCTL_CLUSTER_UNKNOWN
- CLUSCTL_CLUSTER_VALIDATE_COMMON_PROPERTIES
- CLUSCTL_CLUSTER_VALIDATE_PRIVATE_PROPERTIES
[in, optional] lpInBuffer
Puntatore a un buffer di input contenente informazioni necessarie per l'operazione o NULL se non sono necessarie informazioni.
[in] nInBufferSize
Dimensione allocata (in byte) del buffer di input.
[out, optional] lpOutBuffer
Puntatore a un buffer di output per ricevere i dati risultanti dall'operazione o NULL se non verranno restituiti dati.
[in] nOutBufferSize
Dimensione allocata (in byte) del buffer di output.
[out, optional] lpBytesReturned
Restituisce le dimensioni effettive (in byte) dei dati risultanti dall'operazione. Se queste informazioni non sono necessarie, passare NULL per lpcbBytesReturned.
Valore restituito
La funzione restituisce uno dei valori seguenti.
Codice restituito | Descrizione |
---|---|
|
L'operazione è stata completata. Se l'operazione richiede un buffer di output, lpcbBytesReturned (se non NULL in input) punta alla dimensione effettiva dei dati restituiti nel buffer. |
|
Il buffer di output a cui fa riferimento lpOutBuffer non era abbastanza grande per contenere i dati risultanti dall'operazione. Il parametro lpcbBytesReturned (se non NULL in input) punta alle dimensioni necessarie per il buffer di output. Solo le operazioni che richiedono una restituzione del buffer di output ERROR_MORE_DATA. Se il parametro lpOutBuffer è NULL e il parametro nOutBufferSize è zero, ERROR_SUCCESS può essere restituito, non ERROR_MORE_DATA. |
L'operazione non ha avuto esito positivo. Se l'operazione richiede un buffer di output, il valore specificato da lpcbBytesReturned (se non NULL in input) non è attendibile. |
Commenti
Se ClusterControl restituisce ERROR_MORE_DATA, impostare nOutBufferSize sul numero di byte puntati da lpcbBytesReturned e chiamare nuovamente la funzione.
Non passare i handle LPC e RPC alla stessa chiamata di funzione. In caso contrario, la chiamata genererà un'eccezione RPC e può avere effetti distruttivi aggiuntivi. Per informazioni sulla creazione degli handle LPC e RPC, vedere Handle LPC e RPC e OpenCluster.
ClusterControl è una delle funzioni del codice di controllo. Per altre informazioni sui codici di controllo e sulle funzioni di codice di controllo, vedere Uso dei codici di controllo.
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 |