OleDbConnectionStringBuilder.TryGetValue(String, Object) Méthode
Définition
Important
Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.
Récupère une valeur correspondant à la clé fournie à partir de l'instance de OleDbConnectionStringBuilder.
public:
override bool TryGetValue(System::String ^ keyword, [Runtime::InteropServices::Out] System::Object ^ % value);
public override bool TryGetValue (string keyword, out object? value);
public override bool TryGetValue (string keyword, out object value);
override this.TryGetValue : string * obj -> bool
Public Overrides Function TryGetValue (keyword As String, ByRef value As Object) As Boolean
Paramètres
- keyword
- String
Clé de l'élément à récupérer.
- value
- Object
Valeur correspondant à keyword
.
Retours
true
si keyword
a été trouvé dans la chaîne de connexion ; sinon, false
.
Exceptions
keyword
contient une valeur Null (Nothing
en Visual Basic).
Exemples
L’exemple suivant illustre le comportement de la TryGetValue méthode .
using System.Data.OleDb;
class Program
{
static void Main()
{
OleDbConnectionStringBuilder builder =
new OleDbConnectionStringBuilder();
builder.ConnectionString = GetConnectionString();
// Call TryGetValue method for multiple
// key names.
DisplayValue(builder, "Data Source");
DisplayValue(builder, "Extended Properties");
// How about implicitly added key/value pairs?
DisplayValue(builder, "Jet OLEDB:System database");
// Invalid keys?
DisplayValue(builder, "Invalid Key");
// Null values?
DisplayValue(builder, null);
Console.WriteLine("Press any key to continue.");
Console.ReadLine();
}
static private void DisplayValue(OleDbConnectionStringBuilder builder, string key)
{
object value = null;
// Although TryGetValue handles missing keys,
// it does not handle passing in a null (Nothing in Visual Basic)
// key. This example traps for that particular error, but
// throws 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.");
}
}
static private string GetConnectionString()
{
// To avoid storing the connection string in your code,
// you can retrieve it from a configuration file using the
// System.Configuration.ConfigurationSettings.AppSettings property.
return "Provider=Microsoft.Jet.OLEDB.4.0;" +
"Data Source=C:\\ExcelDemo.xls;" +
"Extended Properties=\"Excel 8.0;HDR=Yes;IMEX=1\"";
}
}
Imports System.Data.OleDb
Module Module1
Sub Main()
Dim builder As New OleDbConnectionStringBuilder
builder.ConnectionString = GetConnectionString()
' Call TryGetValue method for multiple
' key names.
DisplayValue(builder, "Data Source")
DisplayValue(builder, "Extended Properties")
' How about implicitly added key/value pairs?
DisplayValue(builder, "Jet OLEDB:System database")
' Invalid keys?
DisplayValue(builder, "Invalid Key")
' Null values?
DisplayValue(builder, Nothing)
Console.WriteLine("Press any key to continue.")
Console.ReadLine()
End Sub
Private Sub DisplayValue( _
ByVal builder As OleDbConnectionStringBuilder, ByVal key As String)
Dim value As Object = Nothing
' Although TryGetValue handles missing keys,
' it does not handle passing in a null (Nothing in Visual Basic)
' key. This example traps for that particular error, but
' throws any other unknown exceptions back out to the
' caller.
Try
If builder.TryGetValue(key, value) Then
Console.WriteLine("{0}='{1}'", key, value)
Else
Console.WriteLine("Unable to retrieve value for '{0}'", key)
End If
Catch ex As ArgumentNullException
Console.WriteLine("Unable to retrieve value for null key.")
End Try
End Sub
Private Function GetConnectionString() As String
' To avoid storing the connection string in your code,
' you can retrieve it from a configuration file using the
' System.Configuration.ConfigurationSettings.AppSettings property.
Return "Provider=Microsoft.Jet.OLEDB.4.0;" & _
"Data Source=C:\ExcelDemo.xls;" & _
"Extended Properties=""Excel 8.0;HDR=Yes;IMEX=1"""
End Function
End Module
Remarques
La méthode TryGetValue permet aux développeurs de récupérer en toute sécurité une valeur à partir d'un OleDbConnectionStringBuilder sans avoir à vérifier que le nom de clé fourni est valide. Étant donné que TryGetValue ne déclenche pas d’exception lorsque vous l’appelez, en passant une clé inexistante, vous n’avez pas besoin de rechercher une clé avant de récupérer sa valeur. L’appel TryGetValue avec une clé inexistante place la valeur null (Nothing
en Visual Basic) dans le value
paramètre .