FONCTION ORGetValue
Récupère le type et les données pour la valeur de Registre spécifiée dans une ruche de Registre hors connexion.
Syntaxe
DWORD ORGetValue(
_In_ ORHKEY Handle,
_In_opt_ PCWSTR lpSubKey,
_In_opt_ PCWSTR lpValue,
_Out_opt_ PDWORD pdwType,
_Out_opt_ PVOID pvData,
_Inout_opt_ PDWORD pcbData
);
Paramètres
-
Handle [in]
-
Handle d’une clé de Registre ouverte dans une ruche de Registre hors connexion.
-
lpSubKey [in, facultatif]
-
Nom de la clé de Registre. Cette clé doit être une sous-clé de la clé spécifiée par le paramètre Handle . Ce paramètre peut être NULL.
Les noms de clés ne respectent pas la casse.
-
lpValue [in, facultatif]
-
Nom de la valeur de Registre. Si ce paramètre a la valeur NULL ou une chaîne vide, « », la fonction récupère le type et les données pour la valeur sans nom de la clé ou la valeur par défaut, le cas échéant. Pour plus d’informations, consultez Limites de taille des éléments de registre.
Les clés n’ont pas automatiquement de valeur sans nom ou par défaut. Les valeurs sans nom peuvent être de n’importe quel type.
Les noms de valeurs ne respectent pas la casse.
-
pdwType [out, facultatif]
-
Pointeur vers une variable qui reçoit un code indiquant le type de données stockées dans la valeur spécifiée. Pour obtenir la liste des codes de type possibles, consultez Types de valeurs du Registre. Ce paramètre peut être NULL si le type n’est pas obligatoire.
-
pvData [out, facultatif]
-
Pointeur vers une mémoire tampon qui reçoit les données de la valeur. Ce paramètre peut être NULL si les données ne sont pas requises.
Si les données sont une chaîne, la fonction recherche un caractère null de fin. Si l’une d’elles est introuvable, la chaîne est stockée avec une marque de fin Null si la mémoire tampon est suffisamment grande pour prendre en charge le caractère supplémentaire. Sinon, la fonction échoue et retourne ERROR_MORE_DATA.
-
pcbData [in, out, optional]
-
Pointeur vers une variable qui spécifie la taille de la mémoire tampon vers laquelle pointe le paramètre pvData , en octets. Lorsque la fonction retourne, cette variable contient la taille des données copiées dans pvData.
Le paramètre pcbData ne peut être NULL que si pvData a la valeur NULL.
Si les données ont le type REG_SZ, REG_MULTI_SZ ou REG_EXPAND_SZ, cette taille inclut le ou les caractères null de fin. Pour plus d'informations, consultez la section Notes.
Si la mémoire tampon spécifiée par le paramètre pvData n’est pas suffisamment grande pour contenir les données, la fonction retourne ERROR_MORE_DATA et stocke la taille de mémoire tampon requise dans la variable pointée par pcbData. Dans ce cas, le contenu de la mémoire tampon pvData n’est pas défini.
Si pvData a la valeur NULL et que pcbData est non NULL, la fonction retourne ERROR_SUCCESS et stocke la taille des données, en octets, dans la variable pointée par pcbData. Cela permet à une application de déterminer la meilleure façon d’allouer une mémoire tampon pour les données de la valeur.
Valeur retournée
Si la fonction réussit, la valeur de retour est ERROR_SUCCESS.
Si la fonction échoue, la valeur de retour est un code d’erreur différent de zéro défini dans Winerror.h. Vous pouvez utiliser la fonction FormatMessage avec l’indicateur FORMAT_MESSAGE_FROM_SYSTEM pour obtenir une description générique de l’erreur.
Notes
Une application appelle généralement la fonction OREnumValue pour déterminer les noms de valeur, puis appelle la fonction ORGetValue pour récupérer les données des noms.
Spécifications
| Condition requise | Valeur |
|---|---|
| Composant redistribuable |
Bibliothèque du Registre windows hors connexion version 1.0 ou ultérieure |
| En-tête |
|
| DLL |
|
Voir aussi