Compartir a través de


Función ClusterResourceEnum (clusapi.h)

Enumera los recursos dependientes de un recurso , los nodos o ambos. Devuelve el nombre de un objeto de clúster con cada llamada. El tipo PCLUSAPI_CLUSTER_RESOURCE_ENUM define un puntero a esta función.

Sintaxis

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

Parámetros

[in] hResEnum

Identificador de enumeración de recursos devuelto por la función ClusterResourceOpenEnum .

[in] dwIndex

Índice del objeto de recurso o nodo que se va a devolver. Este parámetro debe ser cero para la primera llamada a la función ClusterResourceEnum y, a continuación, incrementarse para las llamadas posteriores.

[out] lpdwType

Tipo de objeto devuelto por ClusterResourceEnum.

Los valores posibles son uno de los siguientes valores de enumeración CLUSTER_RESOURCE_ENUM:

CLUSTER_RESOURCE_ENUM_DEPENDS (1)

El objeto es un recurso y hResEnum es un recurso que depende de este objeto.

CLUSTER_RESOURCE_ENUM_PROVIDES (2)

El objeto es un recurso que depende del recurso identificado por hResEnum.

CLUSTER_RESOURCE_ENUM_NODES (4)

El objeto es un nodo que puede hospedar el recurso identificado por hResEnum.

[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 carácter nulo de terminación. En la salida, especifica el número de caracteres en el nombre resultante, excepto el carácter nulo 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 completó correctamente o el parámetro lpszName es NULL.
ERROR_MORE_DATA
234 (0xEA)
El búfer al que apunta el parámetro 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 carácter nulo de terminación.
ERROR_NO_MORE_ITEMS
259 (0x103)
No hay más objetos que se van a devolver.
Código de error del sistema
Cualquier otro código de error devuelto indica que se produjo un error en la operación.

Comentarios

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 carácter nulo 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.

No llame a ClusterResourceEnum desde ninguna función de punto de entrada dll de recursos. ClusterResourceEnum se puede llamar de forma segura desde un subproceso de trabajo. Para obtener más información, consulte Llamadas de función para evitar en archivos DLL de recursos.

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

Consulte también

Funciones de administración de recursos de clúster

ClusterResourceCloseEnum

ClusterResourceOpenEnum