DeleteSetting 関数

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

更新 : 2007 年 11 月

Windows レジストリのアプリケーションの初期設定ファイルから、セクションまたはキー設定を削除します。

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

Public Sub DeleteSetting( _
   ByVal AppName As String, _
   Optional ByVal Section As String = Nothing, _
   Optional ByVal Key As String = Nothing _
)

パラメータ

AppName
必ず指定します。セクションまたはキー設定を適用するアプリケーション名またはプロジェクト名を含む文字列型 (String) の式を指定します。
Section
必ず指定します。キー設定を削除するセクション名を含む文字列型 (String) の式を指定します。AppName および Section だけを指定した場合、指定されたセクションは関連付けられたすべてのキー設定と共に削除されます。
Key
省略できます。削除するキー設定名を含む文字列型 (String) の式を指定します。

例外

例外の種類	エラー番号	条件
ArgumentException	5	Section、AppName、または Key の設定値が存在していません。
ArgumentException	5	ユーザーがログインしていません。

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

解説

引数をすべて指定した場合、指定したキー設定が削除されます。ただし、指定したセクションまたはキー設定が存在しない場合に DeleteSetting を使用すると、ランタイムエラーが発生します。

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

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

使用例

次の例は、最初に SaveSetting プロシージャを使用して、Windows のレジストリに MyApp アプリケーションのエントリを作成します。次に、DeleteSetting 関数を使用して、作成したエントリを削除します。引数 Key を指定していないため、セクション名とセクションのすべてのキーを含む Startup セクション全体が削除されます。

' Place some settings in the registry.
SaveSetting("MyApp", "Startup", "Top", "75")
SaveSetting("MyApp","Startup", "Left", "50")
' Remove section and all its settings from registry.
DeleteSetting ("MyApp", "Startup")
' Remove MyApp from the registry.
DeleteSetting ("MyApp")