Función ClusterNodeEnum (clusapi.h)

Artículo
02/26/2024

Enumera las interfaces de red o los grupos instalados en un nodo y devuelve el nombre de cada una con cada llamada. El tipo PCLUSAPI_CLUSTER_NODE_ENUM define un puntero a esta función.

Sintaxis

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

Parámetros

[in] hNodeEnum

Identificador de un objeto de enumeración existente devuelto originalmente por la función ClusterNodeOpenEnum .

[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 ClusterNodeEnum y, a continuación, incrementarse para las llamadas posteriores.

[out] lpdwType

Puntero al tipo de objeto devuelto. El siguiente valor de la enumeración CLUSTER_NODE_ENUM se devuelve con cada llamada.

CLUSTER_NODE_ENUM_NETINTERFACES (1)

El objeto es una interfaz de red.

CLUSTER_NODE_ENUM_GROUPS (0x00000002)

El objeto es un grupo de clústeres.

Windows Server 2008: El valor de CLUSTER_NODE_ENUM_GROUPS no se admite antes de Windows Server 2008 R2.

[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

Para usar ClusterNodeEnum, las aplicaciones abren primero un identificador de enumeración de nodos llamando a ClusterNodeOpenEnum con el parámetro dwType establecido en CLUSTER_NODE_ENUM_NETINTERFACES. Para obtener más información, vea Enumerar objetos.

Tenga en cuenta que el parámetro 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

Requisito	Value
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