Función ClusterRegEnumKey (clusapi.h)
Enumera las subclaves de una clave de base de datos de clúster abierta.
Sintaxis
LONG ClusterRegEnumKey(
[in] HKEY hKey,
[in] DWORD dwIndex,
[out] LPWSTR lpszName,
[in, out] LPDWORD lpcchName,
[out, optional] PFILETIME lpftLastWriteTime
);
Parámetros
[in] hKey
HKEY que especifica una clave abierta actualmente.
[in] dwIndex
Índice usado para identificar la siguiente subclave que se va a enumerar. Este parámetro debe ser cero para la primera llamada a ClusterRegEnumKey y, a continuación, incrementarse para las llamadas posteriores.
Dado que las subclaves no están ordenadas, ninguna nueva subclave tiene un índice arbitrario. Esto significa que ClusterRegEnumKey puede devolver subclaves en cualquier orden.
[out] lpszName
Puntero a un búfer que recibe el nombre de la subclave, incluido el carácter de terminación null. La función copia solo el nombre de la subclave, no la jerarquía de claves completa, en el búfer.
[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.
[out, optional] lpftLastWriteTime
Puntero a la última vez que se modificó la subclave enumerada.
Valor devuelto
La función devuelve uno de los valores siguientes.
Código o valor devuelto | Descripción |
---|---|
|
La operación se realizó correctamente. |
|
No hay más subclaves que se van a devolver. |
|
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 en la operación. |
Comentarios
La función ClusterRegEnumKey recupera información sobre una subclave cada vez que se llama a ella.
Dado que ClusterRegEnumKey enumera las claves de la raíz de la base de datos en el nodo en el que se ejecuta la aplicación cuando hKey se establece en NULL, ClusterRegEnumKey produce un error si el nodo no forma parte de un clúster.
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 |