SqlConnectionStringBuilder.TryGetValue(String, Object) メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
提供されたキーに対応する値をこの SqlConnectionStringBuilder から取得します。
public:
override bool TryGetValue(System::String ^ keyword, [Runtime::InteropServices::Out] System::Object ^ % value);public override bool TryGetValue (string keyword, out object value);override this.TryGetValue : string * obj -> boolPublic Overrides Function TryGetValue (keyword As String, ByRef value As Object) As Booleanパラメーター
- keyword
- String
取得する項目のキー。
- value
- Object
keyword に対応する値。
戻り値
keyword が接続文字列内で見つかった場合は true。それ以外の場合は false。
例外
keyword に null 値 (Visual Basic の場合は Nothing) が含まれています。
例
次の例では、 TryGetValue メソッドの動作を示します。
using Microsoft.Data.SqlClient;
class Program
{
static void Main()
{
SqlConnectionStringBuilder builder = new SqlConnectionStringBuilder();
builder.ConnectionString = GetConnectionString();
// Call TryGetValue method for multiple
// key names. Note that these keys are converted
// to well-known synonynms for data retrieval.
DisplayValue(builder, "Data Source");
DisplayValue(builder, "Trusted_Connection");
DisplayValue(builder, "InvalidKey");
DisplayValue(builder, null);
Console.WriteLine("Press any key to continue.");
Console.ReadLine();
}
private static void DisplayValue(
SqlConnectionStringBuilder builder, string key)
{
object value = null;
// Although TryGetValue handles missing keys,
// it doesn't handle passing in a null
// key. This example traps for that particular error, but
// passes any other unknown exceptions back out to the
// caller.
try
{
if (builder.TryGetValue(key, out value))
{
Console.WriteLine("{0}='{1}'", key, value);
}
else
{
Console.WriteLine("Unable to retrieve value for '{0}'", key);
}
}
catch (ArgumentNullException)
{
Console.WriteLine("Unable to retrieve value for null key.");
}
}
private static string GetConnectionString()
{
// To avoid storing the connection string in your code,
// you can retrieve it from a configuration file.
return "Server=(local);Integrated Security=SSPI;" +
"Initial Catalog=AdventureWorks";
}
}
このサンプルを実行すると、次の結果が表示されます。
Data Source=(local)
Trusted_Connection=True
Unable to retrieve value for 'InvalidKey'
Unable to retrieve value for null key.
注釈
開発者は、TryGetValue メソッドを使用すると、SqlConnectionStringBuilder から安全に値を取得できます。提供されたキー名が有効なキー名であるかどうかを確認する必要はありません。 TryGetValue を呼び出しても例外は発生しないため、存在しないキーを渡します。値を取得する前にキーを検索する必要はありません。 存在しないキーを指定して TryGetValue を呼び出すと、 パラメーターに null (Nothing Visual Basic の場合) の値が value 配置されます。