Función ClusterNetworkEnum (clusapi.h)

Artículo
03/08/2023

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

Sintaxis

DWORD ClusterNetworkEnum(
  [in]      HNETWORKENUM hNetworkEnum,
  [in]      DWORD        dwIndex,
  [out]     LPDWORD      lpdwType,
  [out]     LPWSTR       lpszName,
  [in, out] LPDWORD      lpcchName
);

Parámetros

[in] hNetworkEnum

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

[in] dwIndex

Índice utilizado para identificar la siguiente entrada que se va a enumerar. Este parámetro debe ser cero para la primera llamada a ClusterNetworkEnum 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_NETWORK_ENUM se devuelve con cada llamada.

CLUSTER_NETWORK_ENUM_NETINTERFACES (1)

El objeto es una interfaz de red.

[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_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 del resultado, excepto el valor NULL de terminación.
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.

Comentarios

La función ClusterNetworkEnum se usa normalmente para recorrer en iteración una colección de objetos de uno o varios tipos que pertenecen a un objeto de red. Si, por ejemplo, una aplicación quiere enumerar todos los objetos de interfaz de red de una red, llama a ClusterNetworkOpenEnum para abrir un enumerador de red que pueda procesar objetos de interfaz de red. El parámetro dwType se establece en CLUSTER_NETWORK_ENUM_NETINTERFACES para especificar interfaces de red como el tipo de objeto que se va a enumerar. Con el identificador que devuelve ClusterNetworkOpenEnum , la aplicación llama repetidamente a ClusterNetworkEnum 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

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