Fonction ClusterRegQueryValue (clusapi.h)

Article
08/22/2023

Retourne le nom, le type et les composants de données associés à une valeur pour une clé de base de données de cluster ouverte.

Syntaxe

LONG ClusterRegQueryValue(
  [in]                HKEY    hKey,
  [in]                LPCWSTR lpszValueName,
  [out, optional]     LPDWORD lpdwValueType,
  [out, optional]     LPBYTE  lpData,
  [in, out, optional] LPDWORD lpcbData
);

Paramètres

[in] hKey

Handle de la clé de base de données de cluster à interroger.

[in] lpszValueName

Pointeur vers une chaîne Unicode terminée par null contenant le nom de la valeur à interroger.

[out, optional] lpdwValueType

Pointeur vers le type de valeur de la clé. Ce paramètre peut être NULL si le type n’est pas obligatoire ; sinon, la valeur retournée par le biais de ce paramètre est l’une des 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 la 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 le nombre d’octets dans la mémoire tampon vers laquelle pointe le paramètre lpbData . Sur la sortie, pointeur vers le nombre d’octets dans les données de la valeur, qui est placé dans le contenu de lpbData si l’appelant passe un pointeur valide.

Le paramètre lpbData peut être NULL uniquement si lpbData a également la valeur NULL.

Valeur retournée

La fonction retourne l’une des valeurs suivantes.

Code/valeur de retour	Description
ERROR_SUCCESS 0 (0x0)	L'opération a réussi.
ERROR_MORE_DATA 234 (0xEA)	La mémoire tampon pointée par lpbData n’est pas assez grande pour contenir les données de la valeur. ClusterRegQueryValue stocke la taille requise dans le contenu de lpbData.

Remarques

Si lpbData a la valeur NULL, la fonction ClusterRegQueryValue retourne ERROR_SUCCESS et stocke la taille des données de la valeur dans le contenu de lpbData. Ces informations permettent à l’appelant d’allouer correctement une mémoire tampon pour contenir les données.

Si lpdwValueType est défini sur REG_SZ, REG_MULTI_SZ ou REG_EXPAND_SZ, lpbData inclut également un terminateur NULL .

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

Voir aussi

ClusterRegOpenKey

Partager via