GetSetting, fonction

S’applique à
Access pour Microsoft 365 Access 2021 Access 2019 Access 2016

Remarque

La fonction, la méthode, l’objet ou la propriété décrite dans cette rubrique est désactivée si le service d’expression Microsoft Jet s’exécute en mode bac à sable, ce qui empêche l’évaluation d’expressions potentiellement dangereuses. Pour plus d’informations sur le mode bac à sable, recherchez « mode bac à sable » dans l’aide.

Retourne une valeur de paramètre de clé à partir de l’entrée d’une application dans le Registre Windows ou (sur Macintosh) dans le fichier d’initialisation de l’application.

Syntaxe

GetSetting(appname, section, key [, default ] )

La syntaxe de la fonction GetSetting contient les arguments suivants :

Argument Description
Appname Obligatoire. expression de chaîne contenant le nom de l’application ou du projet dont le paramètre de clé est demandé. Sur Macintosh, il s’agit du nom du fichier d’initialisation dans le dossier Préférences du dossier Système.
section Obligatoire. Expression de chaîne contenant le nom de la section où se trouve le paramètre de clé.
Clé Obligatoire. Expression de chaîne contenant le nom du paramètre de clé à retourner.
par défaut Facultatif. Expression contenant la valeur à retourner si aucune valeur n’est définie dans le paramètre de clé. En cas d’omission, la valeur par défaut est supposée être une chaîne de longueur nulle («  »).

    

Remarques

Si l’un des éléments nommés dans les arguments GetSetting n’existe pas, GetSetting renvoie la valeur par défaut.

Exemple

Remarque

Les exemples suivants illustrent l’utilisation de cette fonction dans un module Visual Basic pour Applications (VBA). Pour plus d’informations sur l’utilisation de VBA, sélectionnez Référence du développeur dans la liste déroulante en regard de Rechercher et entrez un ou plusieurs termes dans la zone de recherche.

Cet exemple utilise d’abord l’instruction SaveSetting pour créer des entrées dans le Registre Windows (ou .ini fichier sur les plateformes Windows 16 bits) pour l’application spécifiée en tant que nom_application, puis utilise la fonction GetSetting pour afficher l’un des paramètres. Étant donné que l’argument par défaut est spécifié, il est garanti qu’une valeur soit retournée. Notez que les noms de section ne peuvent pas être récupérés avec GetSetting. Enfin, l’instruction DeleteSetting supprime toutes les entrées de l’application.

' Variant to hold 2-dimensional array returned 
' by GetSetting.
Dim MySettings As Variant
' Place some settings in the registry.
SaveSetting "MyApp","Startup", "Top", 75
SaveSetting "MyApp","Startup", "Left", 50
Debug.Print GetSetting(appname := "MyApp", _
            section := "Startup", _
            key := "Left", default := "25")
DeleteSetting "MyApp", "Startup"