GetSetting, fonction

Article
09/12/2008

Mise à jour : novembre 2007

Retourne une valeur de paramètre de clé pour une application dans la base de registres de Windows.

La fonctionnalité My vous permet une meilleure productivité et de meilleures performances dans les opérations de Registre que GetAllSettings. Pour plus d'informations, consultez My.Computer.Registry, objet.

Public Function GetSetting( _
   ByVal AppName As String, _
   ByVal Section As String, _
   ByVal Key As String, _
   Optional ByVal Default As String = "" _
) As String

Paramètres

AppName
Requis. Expression String contenant le nom de l'application ou du projet dont le paramètre de clé est demandé.
Section
Requis. Expression String contenant le nom de la section dans laquelle le paramètre de clé est trouvé.
Key
Requis. Expression String contenant le nom du paramètre de clé à retourner.
Default
Facultatif. Expression contenant la valeur à retourner si aucune valeur n'est définie dans le paramètre Key. S'il est omis, la valeur Default est considérée comme une chaîne de longueur nulle ("").

Exceptions

Type d'exception	Numéro de l'erreur	Condition
ArgumentException	5	Au moins un argument n'est pas une expression String ou l'utilisateur n'est pas connecté.

Consultez la colonne « Numéro d'erreur » si vous mettez à niveau des applications Visual Basic 6.0 qui utilisent la gestion non structurée des erreurs. (Vous pouvez comparer le numéro d'erreur par rapport à Number, propriété (objet Err).) Toutefois, lorsque cela est possible, vous devez envisager de remplacer un tel contrôle d'erreurs par Vue d'ensemble de la gestion structurée des exceptions pour Visual Basic.

Notes

Si l'un des éléments nommés dans les arguments GetSetting n'existe pas, GetSetting retourne la valeur Default.

GetSetting nécessite qu'un utilisateur soit connecté, car elle fonctionne sous la clé de Registre HKEY_LOCAL_USER, qui n'est active que lorsque l'utilisateur se connecte de façon interactive.

Les paramètres de Registre accessibles via un processus non interactif (tel que Mtx.exe) doivent être stockés au-dessous des clés de Registre HKEY_LOCAL_MACHINE\Software\ ou HKEY_USER\DEFAULT\Software.

GetSetting nécessite l'autorisation RegistreRead .

Exemple

Cet exemple utilise d'abord la fonction SaveSetting pour entrer des données dans la base de registres de Windows pour l'application spécifiée en tant que AppName, puis utilise la fonction GetSetting pour afficher l'un des paramètres. Dans la mesure où l'argument Default est spécifié, le retour d'une valeur est garanti. Notez que les noms de Section ne peuvent pas être récupérés par GetSetting. Enfin, la fonction DeleteSetting supprime les entrées de l'application.

' Place some settings in the registry.
SaveSetting("MyApp", "Startup", "Top", "75")
SaveSetting("MyApp", "Startup", "Left", "50")
Console.WriteLine(GetSetting("MyApp", "Startup", "Left", "25"))
DeleteSetting("MyApp")