Função ClusterOpenEnum (clusapi.h)
Abre um enumerador para iteração por meio de objetos de cluster em um cluster. O tipo PCLUSAPI_CLUSTER_OPEN_ENUM define um ponteiro para essa função.
Sintaxe
HCLUSENUM ClusterOpenEnum(
[in] HCLUSTER hCluster,
[in] DWORD dwType
);
Parâmetros
[in] hCluster
Um identificador para um cluster.
[in] dwType
Uma máscara de bits que descreve o tipo de objetos a serem enumerados. Um ou mais dos seguintes valores da enumeração CLUSTER_ENUM são válidos.
CLUSTER_ENUM_NODE (1 (0x1))
Enumera os nós no cluster.
CLUSTER_ENUM_RESTYPE (2 (0x2))
Enumera os tipos de recursos no cluster.
CLUSTER_ENUM_RESOURCE (4 (0x4))
Enumera os recursos no cluster.
CLUSTER_ENUM_GROUP (8 (0x8))
Enumera os grupos no cluster.
CLUSTER_ENUM_NETWORK (16 (0x10))
Enumera as redes no cluster.
CLUSTER_ENUM_NETINTERFACE (32 (0x20))
Enumera os adaptadores de rede no cluster.
CLUSTER_ENUM_SHARED_VOLUME_RESOURCE (1073741824 (0x40000000))
Enumera os volumes compartilhados de cluster usados pelo cluster.
CLUSTER_ENUM_INTERNAL_NETWORK (2147483648 (0x80000000))
Enumera as redes usadas pelo cluster para comunicação interna. As redes são enumeradas em ordem de prioridade mais alta a mais baixa, conforme estabelecido por SetClusterNetworkPriorityOrder.
CLUSTER_ENUM_ALL ((CLUSTER_ENUM_NODE | CLUSTER_ENUM_RESTYPE | CLUSTER_ENUM_RESOURCE | CLUSTER_ENUM_GROUP | CLUSTER_ENUM_NETWORK | CLUSTER_ENUM_NETINTERFACE))
Enumera todos os objetos de cluster.
Retornar valor
Se a operação for bem-sucedida, ClusterOpenEnum retornará um identificador para um enumerador de cluster.
Se a operação falhar, a função retornará NULL. Para obter mais informações sobre o erro, chame a função GetLastError.
Comentários
Os aplicativos chamam a função ClusterOpenEnum para criar um tipo específico de enumerador.
ClusterOpenEnum pode criar enumeradores para iteração por meio de grupos, nós, tipos de recursos, recursos ou todos eles. Por exemplo, um aplicativo pode chamar ClusterOpenEnum para obter uma enumeração de todos os nós e grupos em um cluster especificando CLUSTER_ENUM_GROUP | CLUSTER_ENUM_NODE
no parâmetro dwType .
ClusterOpenEnum retorna um identificador que pode ser passado para ClusterEnum para acessar cada um dos grupos ou nós de cluster e para ClusterCloseEnum para liberar o enumerador.
Exemplos
Consulte Enumerando objetos.
Requisitos
Requisito | Valor |
---|---|
Cliente mínimo com suporte | Nenhum compatível |
Servidor mínimo com suporte | Windows Server 2008 Enterprise, Windows Server 2008 Datacenter |
Plataforma de Destino | Windows |
Cabeçalho | clusapi.h |
Biblioteca | ClusAPI.lib |
DLL | ClusAPI.dll |