GetAllSettings 関数

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

更新 : 2007 年 11 月

Windows レジストリのアプリケーションの初期設定ファイルから、キー設定とその設定値 (SaveSetting により作成) の一覧を返します。

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

Public Function GetAllSettings( _
   ByVal AppName As String, _ 
   ByVal Section As String _
) As String(,)

パラメータ

AppName
必ず指定します。キー設定を取得するアプリケーション名またはプロジェクト名を含む文字列型 (String) の式を指定します。
Section
必ず指定します。キー設定を要求されているセクションの名前を含む String 式です。GetAllSettings は文字列の 2 次元配列を含むオブジェクトを返します。文字列には、指定したセクションのすべてのキー設定と、その設定に対応する値が含まれます。

例外

例外の種類	エラー番号	条件
ArgumentException	5	ユーザーがログインしていません。

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

解説

AppName または Section が存在しない場合、GetAllSettings は初期化されていない Object を返します。

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

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

使用例

次の例は、最初に SaveSetting 関数を使用して、AppName として指定したアプリケーションのエントリを Windows のレジストリに作成します。次に、GetAllSettings 関数を使用して、設定を表示します。GetAllSettings 関数では、アプリケーション名および Section 名は取得できません。最後に、DeleteSetting 関数でアプリケーションのエントリを削除します。

' Object to hold 2-dimensional array returned by GetAllSettings.
' Integer to hold counter.
Dim MySettings(,) As String
Dim intSettings As Integer
' Place some settings in the registry.
SaveSetting("MyApp", "Startup", "Top", "75")
SaveSetting("MyApp", "Startup", "Left", "50")
' Retrieve the settings.
MySettings = GetAllSettings("MyApp", "Startup")
For intSettings = LBound(MySettings, 1) To UBound(MySettings, 1)
   WriteLine(1, MySettings(intSettings, 0))
   WriteLine(1, MySettings(intSettings, 1))
Next intSettings
DeleteSetting("MyApp")