Função ClusterResourceEnum (clusapi.h)

Enumera os recursos dependentes de um recurso , nós ou ambos. Ele retorna o nome de um objeto de cluster com cada chamada. O tipo PCLUSAPI_CLUSTER_RESOURCE_ENUM define um ponteiro para essa função.

Sintaxe

DWORD ClusterResourceEnum(
  [in]      HRESENUM hResEnum,
  [in]      DWORD    dwIndex,
  [out]     LPDWORD  lpdwType,
  [out]     LPWSTR   lpszName,
  [in, out] LPDWORD  lpcchName
);

Parâmetros

[in] hResEnum

Um identificador de enumeração de recursos retornado da função ClusterResourceOpenEnum .

[in] dwIndex

O índice do recurso ou objeto de nó a ser retornado. Esse parâmetro deve ser zero para a primeira chamada para a função ClusterResourceEnum e incrementado para chamadas subsequentes.

[out] lpdwType

O tipo de objeto retornado por ClusterResourceEnum.

Os valores possíveis são um dos seguintes valores de enumeração CLUSTER_RESOURCE_ENUM :

CLUSTER_RESOURCE_ENUM_DEPENDS (1)

O objeto é um recurso e hResEnum é um recurso que depende desse objeto.

CLUSTER_RESOURCE_ENUM_PROVIDES (2)

O objeto é um recurso que depende do recurso identificado por hResEnum.

CLUSTER_RESOURCE_ENUM_NODES (4)

O objeto é um nó que pode hospedar o recurso identificado por hResEnum.

[out] lpszName

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

[in, out] lpcchName

Um 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 caractere nulo de terminação. Na saída, especifica o número de caracteres no nome resultante, excluindo o caractere nulo 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 êxito ou o parâmetro lpszName é NULL.
ERROR_MORE_DATA 234 (0xEA)	O buffer apontado pelo parâmetro lpszName não é grande o suficiente para manter o resultado. O parâmetro lpcchName retorna o número de caracteres no resultado, excluindo o caractere nulo de terminação.
ERROR_NO_MORE_ITEMS 259 (0x103)	Não há mais objetos a serem retornados.
Código de erro do sistema	Qualquer outro código de erro retornado indica que a operação falhou.

Comentários

Observe que 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 caractere nulo de terminação na contagem. Para obter mais informações sobre o dimensionamento de buffers, consulte Convenções de tamanho de dados.

Não chame ClusterResourceEnum de nenhuma função de ponto de entrada DLL de recurso. ClusterResourceEnum pode ser chamado com segurança de um thread de trabalho. Para obter mais informações, consulte Chamadas de função a serem evitadas em DLLs de recurso.

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

Funções de gerenciamento de recursos de cluster

ClusterResourceCloseEnum

ClusterResourceOpenEnum