Fonction ClusterRegEnumValue (clusapi.h)
Énumère les valeurs d’une clé de base de données de cluster ouverte.
Syntaxe
DWORD ClusterRegEnumValue(
[in] HKEY hKey,
[in] DWORD dwIndex,
[out] LPWSTR lpszValueName,
[in, out] LPDWORD lpcchValueName,
[out, optional] LPDWORD lpdwType,
[out, optional] LPBYTE lpData,
[in, out, optional] LPDWORD lpcbData
);
Paramètres
[in] hKey
Handle de la clé de base de données de cluster à énumérer.
[in] dwIndex
Index utilisé pour identifier la valeur suivante à énumérer. Ce paramètre doit être égal à zéro pour le premier appel à ClusterRegEnumValue , puis incrémenté pour les appels suivants.
Étant donné que les valeurs ne sont pas triées, toute nouvelle valeur a un index arbitraire. Cela signifie que ClusterRegEnumValue peut retourner des valeurs dans n’importe quel ordre.
[out] lpszValueName
Pointeur vers une chaîne Unicode terminée par un caractère Null contenant le nom de la valeur retournée.
[in, out] lpcchValueName
Pointeur vers la taille de la mémoire tampon lpszValueName 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. Lors de la sortie, spécifie le nombre de caractères dans le nom résultant, à l’exclusion de la valeur NULL de fin.
[out, optional] lpdwType
Pointeur vers le code de type pour l’entrée de valeur, ou NULL si le code de type n’est pas requis. Le code de type peut être l’une des valeurs suivantes.
REG_BINARY (3)
Données binaires dans tout formulaire.
REG_DWORD (4)
Nombre 32 bits.
REG_DWORD_BIG_ENDIAN (5)
Nombre 32 bits stocké au format big-endian.
REG_EXPAND_SZ (2)
Chaîne Unicode terminée par null qui contient des références non expirées à des variables d’environnement (par exemple, « %PATH% »).
REG_MULTI_SZ (6)
Séquence de chaînes terminées par un caractère Null, terminée par une chaîne vide (\0).
Par exemple :
String1\0String2\0String3\0LastString\0\0
Le premier \0 termine la première chaîne, le deuxième au dernier \0 termine la dernière chaîne et le dernier \0 termine la séquence. Notez que le terminateur final doit être pris en compte dans la longueur de la chaîne.
REG_NONE (0)
Aucun type valeur défini.
REG_QWORD (11)
Nombre 64 bits.
REG_SZ (1)
Chaîne Unicode terminée par un caractère Null.
[out, optional] lpData
Pointeur vers les données de l’entrée de valeur. Ce paramètre peut être NULL si les données ne sont pas requises.
[in, out, optional] lpcbData
Lors de l’entrée, pointeur vers un nombre d’octets dans la mémoire tampon vers laquelle pointe le paramètre lpbData . Sur la sortie, pointeur vers un nombre d’octets résultant de l’opération. Ce paramètre peut être NULL uniquement si lpbData a la valeur NULL.
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 valeurs à retourner. |
|
L’une des mémoires tampons de sortie (lpszValueName ou lpbData) est trop petite pour contenir les données obtenues. Les paramètres lpcchValueName et lpbData indiquent la taille requise (notez que lpcchValueName n’inclut pas la valeur NULL de fin dans le nombre de caractères). |
L'opération a échoué. |
Configuration requise
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 |