Funzione ClusterRegEnumKey (clusapi.h)

Articolo
03/08/2023

Enumera le sottochiavi di una chiave di database cluster aperta.

Sintassi

LONG ClusterRegEnumKey(
  [in]            HKEY      hKey,
  [in]            DWORD     dwIndex,
  [out]           LPWSTR    lpszName,
  [in, out]       LPDWORD   lpcchName,
  [out, optional] PFILETIME lpftLastWriteTime
);

Parametri

[in] hKey

HKEY che specifica una chiave attualmente aperta.

[in] dwIndex

Indice utilizzato per identificare la sottochiave successiva da enumerare. Questo parametro deve essere zero per la prima chiamata a ClusterRegEnumKey e quindi incrementato per le chiamate successive.

Poiché le sottochiavi non sono ordinate, qualsiasi nuova sottochiave ha un indice arbitrario. Ciò significa che ClusterRegEnumKey può restituire sottochiavi in qualsiasi ordine.

[out] lpszName

Puntatore a un buffer che riceve il nome della sottochiave, incluso il carattere di terminazione Null. La funzione copia solo il nome della sottochiave, non la gerarchia di chiavi completa, nel buffer.

[in, out] lpcchName

Puntatore alla dimensione del buffer lpszName come numero di caratteri. In input, specificare il numero massimo di caratteri che il buffer può contenere, incluso il valore NULL di terminazione. Nell'output specifica il numero di caratteri nel nome risultante, escluso il valore NULL di terminazione.

[out, optional] lpftLastWriteTime

Puntatore all'ultima modifica della sottochiave enumerata.

Valore restituito

La funzione restituisce uno dei valori seguenti.

Codice/valore restituito	Descrizione
ERROR_SUCCESS 0	L'operazione è stata completata.
ERROR_NO_MORE_ITEMS 259 (0x103)	Non sono più presenti sottochiavi da restituire.
ERROR_MORE_DATA 234 (0xEA)	Il buffer a cui punta lpszName non è abbastanza grande per contenere il risultato. Il parametro lpcchName restituisce il numero di caratteri nel risultato, escluso il valore NULL di terminazione.
Codice di errore di sistema	Operazione non riuscita.

Commenti

La funzione ClusterRegEnumKey recupera informazioni su una sottochiave ogni volta che viene chiamata.

Poiché ClusterRegEnumKey enumera le chiavi dalla radice del database nel nodo in cui viene eseguita l'applicazione quando hKey è impostato su NULL, ClusterRegEnumKey ha esito negativo se il nodo non fa parte di un cluster.

Requisiti

Requisito	Valore
Client minimo supportato	Nessuno supportato
Server minimo supportato	Windows Server 2008 Enterprise, Windows Server 2008 Datacenter
Piattaforma di destinazione	Windows
Intestazione	clusapi.h
Libreria	ClusAPI.lib
DLL	ClusAPI.dll

Vedi anche

Funzioni di accesso al Registro di sistema del cluster

ClusterRegOpenKey

Condividi tramite