Função ClusterNodeEnum (clusapi.h)

Enumera os adaptadores de rede ou grupos instalados em um nó, retornando o nome de cada um com cada chamada. O tipo PCLUSAPI_CLUSTER_NODE_ENUM define um ponteiro para essa função.

Sintaxe

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

Parâmetros

[in] hNodeEnum

Manipule para um objeto de enumeração existente originalmente retornado pela função ClusterNodeOpenEnum .

[in] dwIndex

Índice usado para identificar a próxima entrada a ser enumerada. Esse parâmetro deve ser zero para a primeira chamada para ClusterNodeEnum e, em seguida, incrementado para chamadas subsequentes.

[out] lpdwType

Ponteiro para o tipo de objeto retornado. O valor a seguir da enumeração CLUSTER_NODE_ENUM é retornado com cada chamada.

CLUSTER_NODE_ENUM_NETINTERFACES (1)

O objeto é um adaptador de rede.

CLUSTER_NODE_ENUM_GROUPS (0x00000002)

O objeto é um grupo de clusters.

Windows Server 2008: Não há suporte para o valor CLUSTER_NODE_ENUM_GROUPS antes do Windows Server 2008 R2.

[out] lpszName

Ponteiro para uma cadeia de caracteres Unicode terminada em nulo que contém o nome do objeto retornado.

[in, out] lpcchName

Ponteiro para o tamanho do buffer lpszName como uma contagem de caracteres. Na entrada, especifique o número máximo de caracteres que o buffer pode conter, incluindo o NULL de terminação. Na saída, especifica o número de caracteres no nome resultante, excluindo o NULL de terminação.

Retornar valor

A função retorna um dos valores a seguir.

Valor/código retornado Descrição
ERROR_SUCCESS
0
 A operação foi concluída com sucesso.
ERROR_NO_MORE_ITEMS
259 (0x103)
 Não existem mais dados disponíveis. Esse valor será retornado se não houver mais objetos do tipo solicitado a serem retornados.
ERROR_MORE_DATA
234 (0xEA)
 Mais dados disponíveis. Esse valor será retornado se o buffer apontado por lpszName não for grande o suficiente para manter o resultado. O parâmetro lpcchName retorna o número de caracteres no resultado, excluindo o NULL de terminação.

Comentários

Para usar ClusterNodeEnum, os aplicativos primeiro abrem um identificador de enumeração de nó chamando ClusterNodeOpenEnum com o parâmetro dwType definido como CLUSTER_NODE_ENUM_NETINTERFACES. Para obter mais informações, consulte Enumerando objetos.

Observe que o parâmetro lpcchName refere-se a uma contagem de caracteres e não a uma contagem de bytes e que o tamanho retornado não inclui o NULL de terminação na contagem. Para obter mais informações sobre o dimensionamento de buffers, consulte Convenções de tamanho de dados.

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

Confira também

ClusterNodeCloseEnum

ClusterNodeOpenEnum

Funções de gerenciamento de nó

  • Last updated on