Interaction.GetSetting メソッド

.NET Framework クラス ライブラリ リファレンス

Interaction.GetSetting メソッド

Windows レジストリのアプリケーションのエントリから、キーの設定値を返します。My 機能を使用すると、GetAllSettings を使用した場合より生産性とパフォーマンスが向上します。詳細については、「My.Computer.Registry オブジェクト」を参照してください。

名前空間: Microsoft.VisualBasic
アセンブリ: Microsoft.VisualBasic (microsoft.visualbasic.dll 内)
構文

Visual Basic (宣言)

Public Shared Function GetSetting
 ( _
    AppName As String, _
    Section As String, _
    Key As String, _
    <OptionalAttribute> Optional Default
 As String = ""
 _
) As String

Visual Basic (使用法)

Dim AppName As String
Dim Section As String
Dim Key As String
Dim Default As String
Dim returnValue As String

returnValue = Interaction.GetSetting(AppName, Section, Key, Default)

C#

public static string GetSetting
 (
    string AppName,
    string Section,
    string Key,
    [OptionalAttribute] string Default
)

C++

public:
static String^ GetSetting (
    String^ AppName, 
    String^ Section, 
    String^ Key, 
    [OptionalAttribute] String^ Default
)

J#

public static String GetSetting (
    String AppName, 
    String Section, 
    String Key, 
    /** @attribute OptionalAttribute() */ String Default
)

JScript

public static function GetSetting
 (
    AppName : String, 
    Section : String, 
    Key : String, 
    Default : String
) : String

パラメータ

AppName

必須。キー設定が必要となるアプリケーションまたはプロジェクトの名前を含む String 式です。

Section

必須。キーの設定が存在しているセクションの名前を含む String 式です。

Key

必須。返されるキー設定の名前を含む String 式です。

Default

省略可能。Key 設定に値が設定されていない場合に返される値を含む式です。省略した場合、Default は長さ 0 の文字列 ("") と想定されます。

戻り値
Windows レジストリのアプリケーションのエントリから、キーの設定値を返します。 My 機能を使用すると、GetAllSettings を使用した場合より生産性とパフォーマンスが向上します。詳細については、「My.Computer.Registry オブジェクト」を参照してください。

解説

詳細については、Visual Basic のトピック「GetSetting 関数」を参照してください。

GetSetting 引数で指定された項目がすべて存在しない場合、GetSetting は Default の値を返します。

この機能の動作に使用される HKEY_LOCAL_USER レジストリ キーは、ユーザーが対話形式でログオンするまでアクティブにならないため、GetSetting を使用するにはユーザーがログオンしている必要があります。

対話形式でないプロセス (Mtx.exe など) からアクセスされるレジストリ設定は、HKEY_LOCAL_MACHINE\Software\ レジストリ キーまたは HKEY_USER\DEFAULT\Software レジストリ キーの下に保存する必要があります。

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

使用例

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

Visual Basic

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

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0

参照

関連項目
Interaction クラス
Interaction メンバ
Microsoft.VisualBasic 名前空間
ArgumentException Class
RegistryPermission Class
その他の技術情報
GetSetting 関数
DeleteSetting 関数
GetAllSettings 関数
SaveSetting 関数
一般的なレジストリ タスク