Fonction ClusterRegEnumKey (clusapi.h)
Énumère les sous-clés d’une clé de base de données de cluster ouverte.
Syntaxe
LONG ClusterRegEnumKey(
[in] HKEY hKey,
[in] DWORD dwIndex,
[out] LPWSTR lpszName,
[in, out] LPDWORD lpcchName,
[out, optional] PFILETIME lpftLastWriteTime
);
Paramètres
[in] hKey
HKEY spécifiant une clé actuellement ouverte.
[in] dwIndex
Index utilisé pour identifier la sous-clé suivante à énumérer. Ce paramètre doit être égal à zéro pour le premier appel à ClusterRegEnumKey , puis incrémenté pour les appels suivants.
Étant donné que les sous-clés ne sont pas triées, toute nouvelle sous-clé a un index arbitraire. Cela signifie que ClusterRegEnumKey peut retourner des sous-clés dans n’importe quel ordre.
[out] lpszName
Pointeur vers une mémoire tampon qui reçoit le nom de la sous-clé, y compris le caractère de fin null. La fonction copie uniquement le nom de la sous-clé, et non la hiérarchie de clés complète, dans la mémoire tampon.
[in, out] lpcchName
Pointeur vers la taille de la mémoire tampon lpszName en tant que nombre de caractères. Lors de l’entrée, spécifiez le nombre maximal de caractères que la mémoire tampon peut contenir, y compris la valeur NULL de fin. Sur la sortie, spécifie le nombre de caractères dans le nom résultant, à l’exclusion de la valeur NULL de fin.
[out, optional] lpftLastWriteTime
Pointeur vers la dernière modification de la sous-clé énumérée.
Valeur retournée
La fonction retourne l’une des valeurs suivantes.
| Code/valeur de retour | Description |
|---|---|
|
L'opération a réussi. |
|
Il n’y a plus de sous-clés à retourner. |
|
La mémoire tampon pointée vers lpszName n’est pas assez grande pour contenir le résultat. Le paramètre lpcchName retourne le nombre de caractères dans le résultat, à l’exclusion de la valeur NULL de fin. |
| L'opération a échoué. |
Remarques
La fonction ClusterRegEnumKey récupère des informations sur une sous-clé chaque fois qu’elle est appelée.
Étant donné que ClusterRegEnumKey énumère les clés de la racine de la base de données sur le nœud sur lequel l’application s’exécute lorsque hKey est défini sur NULL, ClusterRegEnumKey échoue si le nœud ne fait pas partie d’un cluster.
Configuration requise
| Condition requise | Valeur |
|---|---|
| Client minimal pris en charge | Aucun pris en charge |
| Serveur minimal pris en charge | Windows Server 2008 Entreprise, Windows Server 2008 Datacenter |
| Plateforme cible | Windows |
| En-tête | clusapi.h |
| Bibliothèque | ClusAPI.lib |
| DLL | ClusAPI.dll |