GetSetting関数

GetSetting関数は、VBA関数の中でWindows・その他の関数に分類される関数です。

GetSetting関数とは

GetSetting関数は、Microsoft Windows のレジストリにあるアプリケーションの項目、または Macintosh の場合にはアプリケーションの初期設定ファイルから、キー設定値を返します。

引数	省略	説明
構文	GetSetting(appname, section, key[, default])
appname	×	キー設定を取得するアプリケーション名またはプロジェクト名を含む文字列式を指定します。Macintosh の場合には、システムフォルダ内の初期設定フォルダに含まれているファイル名を指定します。
section	×	対象となるキー設定があるセクション名を含む文字列式を指定します。
key	×	取得するキー設定名を含む文字列式を指定します。
default	●	キー設定に値が設定されていない場合に返す値を含む式を指定します。省略すると、長さ 0 の文字列 ("") とみなされます。

GetSetting 関数の名前付き引数のいずれかを指定していない場合、GetSetting 関数では、名前付き引数 default の値が返されます。

GetSetting関数のサンプルコード

次の例は、SaveSetting ステートメントを使用して、名前付き引数 appname に指定したアプリケーションのエントリを Windows のレジストリ (16 ビット版 Windows の場合は、.INI ファイル) に作成します。次に、GetSetting 関数を使用して、設定の 1 つを表示します。名前付き引数 default を指定すると、必ず値が返されます。GetSetting 関数では、セクション名は取得できません。最後に、DeleteSetting ステートメントを使用して、アプリケーションのすべてのセクションを削除します。


Sub Sample()

' GetSetting 関数によって返される二次元配列を格納するためにバリアント型変数を宣言します。
Dim MySettings As Variant
' レジストリに設定を書き込みます。
SaveSetting "MyApp","Startup", "Top", 75
SaveSetting "MyApp","Startup", "Left", 50

Debug.Print GetSetting(appname := "MyApp", section := "Startup", _
                       key := "Left", default := "25")

DeleteSetting "MyApp", "Startup"



End Sub

実行結果

解説

Windows・その他の関数一覧

関数名	内容
Command	起動時に指定されたコマンドラインの引数を返します。
CreateObject	ActiveXオブジェクトへの参照を作成して返します。
DoEvents	VBAからWindowsにイベントの処理を依頼します。
Environ	OSの環境変数に割り当てられた名前を返します。
Environ$	指定した数番目の環境変数を返します。
GetAllSettings	アプリケーションの項目からすべてのキー設定に対応する値リストを返します。
GetObject	ファイルから取得したActiveXオブジェクトへの参照を返します。
GetSetting	アプリケーションの項目からキー設定値を返します。
IMEStatus	MS-IME(日本語入力システム)の現在の状態を返します。
QBColor	指定した番号に対応するRGBコードを返します。
RGB	RGBの値を色で指定します。
Shell	指定したプログラムを実行します。