GetSetting 函式

發行項
08/21/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 將被視為長度為零的字串 ("")。

例外狀況

例外狀況類型	錯誤代碼	條件
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 登錄機碼 (Registry Key) 之下。

GetSetting 需要 Read登錄使用權限。

範例

這個範例會先使用 SaveSetting 函式在 Windows 登錄中為指定為 AppName 的應用程式建立項目，然後使用 GetSetting 函式來顯示其中一個設定。由於已指定了 Default 引數，因此保證會傳回一些值。請注意，不能以 GetSetting 擷取 Section 名稱。最後，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")