Share via

Función ClusterEnum (clusapi.h)

  • Artículo

Enumera los objetos de clúster de un clúster y devuelve el nombre de un objeto con cada llamada. El tipo PCLUSAPI_CLUSTER_ENUM define un puntero a esta función.

Sintaxis

DWORD ClusterEnum(
  [in]      HCLUSENUM hEnum,
  [in]      DWORD     dwIndex,
  [out]     LPDWORD   lpdwType,
  [out]     LPWSTR    lpszName,
  [in, out] LPDWORD   lpcchName
);

Parámetros

[in] hEnum

Identificador de enumeración de clúster devuelto por la función ClusterOpenEnum .

[in] dwIndex

Índice usado para identificar la siguiente entrada que se va a enumerar. Este parámetro debe ser cero para la primera llamada a ClusterEnum y, a continuación, incrementarse para las llamadas posteriores.

[out] lpdwType

Puntero al tipo de objeto devuelto. Uno de los siguientes valores de la enumeración CLUSTER_ENUM se devuelve con cada llamada.

CLUSTER_ENUM_NODE (1 (0x1))

Enumera los nodos del clúster.

CLUSTER_ENUM_RESTYPE (2 (0x2))

Enumera los tipos de recursos del clúster.

CLUSTER_ENUM_RESOURCE (4 (0x4))

Enumera los recursos del clúster.

CLUSTER_ENUM_GROUP (8 (0x8))

Enumera los grupos del clúster.

CLUSTER_ENUM_NETWORK (16 (0x10))

Enumera las redes del clúster.

CLUSTER_ENUM_NETINTERFACE (32 (0x20))

Enumera las interfaces de red del clúster.

CLUSTER_ENUM_SHARED_VOLUME_RESOURCE (1073741824 (0x40000000))

Enumera los volúmenes compartidos de clúster usados por el clúster.

Nota A diferencia de la mayoría de las otras máscaras de bits de enumeración, este valor se debe usar solo. No use el operador OR para combinarlo con otras máscaras de bits.
 
Windows Server 2008: El valor de CLUSTER_ENUM_SHARED_VOLUME_RESOURCE no se admite antes de Windows Server 2008 R2.

CLUSTER_ENUM_INTERNAL_NETWORK (2147483648 (0x80000000))

Enumera las redes usadas por el clúster para la comunicación interna. Las redes se enumeran en orden de prioridad más alta a menor según lo establecido por la función SetClusterNetworkPriorityOrder .

Nota A diferencia de la mayoría de las otras máscaras de bits de enumeración, este valor se debe usar solo. No use el operador OR para combinarlo con otras máscaras de bits.
 

CLUSTER_ENUM_ALL ((CLUSTER_ENUM_NODE | CLUSTER_ENUM_RESTYPE | CLUSTER_ENUM_RESOURCE | CLUSTER_ENUM_GROUP | CLUSTER_ENUM_NETWORK | CLUSTER_ENUM_NETINTERFACE))

Enumera todos los objetos de clúster.

[out] lpszName

Puntero a una cadena Unicode terminada en null que contiene el nombre del objeto devuelto.

[in, out] lpcchName

Puntero al tamaño del búfer lpszName como recuento de caracteres. En la entrada, especifique el número máximo de caracteres que puede contener el búfer, incluido el valor NULL de terminación. En la salida, especifica el número de caracteres en el nombre resultante, excepto el valor NULL de terminación.

Valor devuelto

La función devuelve uno de los valores siguientes.

Código o valor devuelto Descripción
ERROR_SUCCESS
0
 La operación se ha completado correctamente.
ERROR_NO_MORE_ITEMS
259 (0x103)
 No más datos disponibles. Este valor se devuelve si no hay más objetos del tipo solicitado que se van a devolver.
ERROR_MORE_DATA
234 (0xEA)
 More data is available (Hyper-V no pudo generar el conjunto de instantáneas de VSS para la máquina virtual: hay más datos disponibles). Este valor se devuelve si el búfer al que apunta lpszName no es lo suficientemente grande como para contener el resultado. El parámetro lpcchName devuelve el número de caracteres en el resultado, excepto el valor NULL de terminación.

Comentarios

La función ClusterEnum se usa normalmente para recorrer en iteración una colección de objetos de clúster de uno o varios tipos. Si, por ejemplo, una aplicación quiere enumerar todos los nodos de un clúster, llama a ClusterOpenEnum para abrir un enumerador de clústeres que pueda procesar nodos. El parámetro dwType se establece en CLUSTER_ENUM_NODE para especificar nodos como el tipo de objeto que se va a enumerar. Si la aplicación enumera los grupos además de los nodos, el parámetro dwType se establece CLUSTER_ENUM_NODE | CLUSTER_ENUM_GROUPen . Con el identificador que ClusterOpenEnum devuelve, la aplicación llama repetidamente a ClusterEnum para recuperar cada uno de los objetos. El parámetro lpdwType apunta al tipo de objeto que se recupera.

Tenga en cuenta que lpcchName hace referencia a un recuento de caracteres y no a un recuento de bytes, y que el tamaño devuelto no incluye el valor NULL de terminación en el recuento. Para obtener más información sobre los búferes de tamaño, consulte Convenciones de tamaño de datos.

Ejemplos

Vea Enumerar objetos.

Requisitos

   
Cliente mínimo compatible No se admite ninguno
Servidor mínimo compatible Windows Server 2008 Enterprise, Windows Server 2008 Datacenter
Plataforma de destino Windows
Encabezado clusapi.h
Library ClusAPI.lib
Archivo DLL ClusAPI.dll

Consulte también

ClusterCloseEnum

ClusterOpenEnum

SetClusterNetworkPriorityOrder