OleDbConnectionStringBuilder.TryGetValue(String, Object) Método
Definición
Importante
Parte de la información hace referencia a la versión preliminar del producto, que puede haberse modificado sustancialmente antes de lanzar la versión definitiva. Microsoft no otorga ninguna garantía, explícita o implícita, con respecto a la información proporcionada aquí.
Recupera un valor correspondiente a la clave proporcionada de la OleDbConnectionStringBuilder instancia.
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
Parámetros
- keyword
- String
Clave del elemento que se va a recuperar.
- value
- Object
Valor correspondiente a keyword.
Devoluciones
true si se encontró keyword en el cadena de conexión; de lo contrario, false.
Excepciones
keyword contiene un valor NULL (Nothing en Visual Basic).
Ejemplos
En el ejemplo siguiente se muestra el comportamiento del TryGetValue método .
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
Comentarios
El TryGetValue método permite a los desarrolladores recuperar de forma segura un valor de un OleDbConnectionStringBuilder sin necesidad de comprobar que el nombre de clave proporcionado es un nombre de clave válido. Dado TryGetValue que no genera una excepción al llamarla, pasar una clave inexistente, no es necesario buscar una clave antes de recuperar su valor. Al llamar a TryGetValue con una clave inexistente, se colocará el valor NULL (Nothing en Visual Basic) en el parámetro value.