GetSetting 関数

[アーティクル]
09/30/2008

更新 : 2007 年 11 月

Windows レジストリのアプリケーションの初期設定ファイルから、キー設定値を返します。

My 機能では、GetAllSettings よりも、レジストリ操作の生産性とパフォーマンスが高くなっています。詳細については、「My.Computer.Registry オブジェクト」を参照してください。

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

パラメータ

AppName
必ず指定します。キー設定を取得するアプリケーション名またはプロジェクト名を含む文字列型 (String) の式を指定します。
Section
必ず指定します。対象となるキー設定があるセクション名を含む文字列型 (String) の式を指定します。
Key
必ず指定します。返すキー設定名を含む文字列型 (String) の式を指定します。
Default
省略可能です。Key 設定に値が設定されていない場合に返す値を含む式。省略すると、Default は長さ 0 の文字列 ("") になります。

例外

例外の種類	エラー番号	条件
ArgumentException	5	文字列型 (String) の式でない引数が含まれるか、ユーザーがログインしていません。

非構造化エラー処理を使用する Visual Basic 6.0 アプリケーションをアップグレードする場合は、「エラー番号」列を参照してください(エラー番号を Number プロパティ (Err オブジェクト) と照らし合わせます)。しかし、可能な限り、このエラー処理は Visual Basic の構造化例外処理の概要で置き換えてください。

解説

GetSetting 関数の引数のいずれかを指定していない場合、GetSetting 関数は、Default の値を返します。

GetSetting は、ユーザーが対話形式でログオンするまでアクティブにならない HKEY_LOCAL_USER レジストリキーのもとで動作するため、ユーザーがログオンしていることが必要条件です。

双方向でないプロセス (Mtx.exe など) からアクセスするレジストリの設定は、HKEY_LOCAL_MACHINE\Software\ または HKEY_USER\DEFAULT\Software レジストリキーのいずれかに格納されます。

GetSetting には、Readレジストリアクセス許可が必要です。

使用例

次の例は、最初に SaveSetting 関数を使用して、AppName として指定したアプリケーションのエントリを Windows のレジストリに作成します。次に、GetSetting 関数を使用して、設定を表示します。引数 Default を指定すると、必ず値が返されます。Section 名は GetSetting では取得できないことに注意してください。最後に、DeleteSetting 関数でアプリケーションのすべてのエントリを削除します。

' 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")