GetSetting, fonction

  • Article

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 nommés suivants :

Élément Description
appname Obligatoire. Expression de chaîne qui contient le nom de l’application ou du projet dont le paramètre de clé est demandé. Sous Macintosh, il s’agit du nom du fichier d’initialisation dans le sous-dossier Préférences du dossier Système.
section Obligatoire. Expression de chaîne qui contient le nom de la section contenant le paramètre de clé.
key Obligatoire. Expression de chaîne qui contient le nom du paramètre de clé à renvoyer.
default Facultatif. Expression qui contient la valeur à renvoyer si aucune valeur n’est définie dans le paramètre de clé. Si aucune valeur n’est spécifiée, la valeur par défaut est supposée comme étant 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

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 défaut est spécifié, une valeur est obligatoirement renvoyée. Notez que les noms de section ne peuvent pas être extraits 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"

Voir aussi

Assistance et commentaires

Avez-vous des questions ou des commentaires sur Office VBA ou sur cette documentation ? Consultez la rubrique concernant l’assistance pour Office VBA et l’envoi de commentaires afin d’obtenir des instructions pour recevoir une assistance et envoyer vos commentaires.