Edit

Share via


OracleConnectionStringBuilder.Item[String] Property

Definition

Gets or sets the value associated with the specified key. In C#, this property is the indexer.

public:
 virtual property System::Object ^ default[System::String ^] { System::Object ^ get(System::String ^ keyword); void set(System::String ^ keyword, System::Object ^ value); };
public override object this[string keyword] { get; set; }
member this.Item(string) : obj with get, set
Default Public Overrides Property Item(keyword As String) As Object

Parameters

keyword
String

The key of the item to get or set.

Property Value

The value associated with the specified key.

Exceptions

keyword is a null reference (Nothing in Visual Basic).

Tried to add a key which does not exist within the available keys.

Invalid value within the connection string (specifically, when a Boolean or numeric value was expected but not supplied).

Examples

The following code, in a console application, creates a new OracleConnectionStringBuilder and adds key/value pairs to its connection string, using the Item[] property.

// You may need to set a reference to the System.Data.OracleClient
// assembly before you can run this sample.
using System.Data.OracleClient;

class Program
{
    static void Main()
    {
        OracleConnectionStringBuilder builder =
            new OracleConnectionStringBuilder();
        builder["Data Source"] = "localhost";
        builder["integrated security"] = true;
        builder["Unicode"] = true;

        // Overwrite the existing value for the Data Source value.
        builder["Data Source"] = "NewOracleDemo";

        Console.WriteLine(builder.ConnectionString);
        Console.WriteLine();
        Console.WriteLine("Press Enter to continue.");
        Console.ReadLine();
    }
}
' You may need to set a reference to the System.Data.OracleClient
' assembly before you can run this sample.
Imports System.Data.OracleClient

Module Module1
  Sub Main()
    Dim builder As New OracleConnectionStringBuilder
    builder.Item("Data Source") = "OracleDemo"
    ' Item is the default property, so 
    ' you need not include it in the reference.
    builder("integrated security") = True
    builder.Item("Unicode") = True

    ' Overwrite the existing value for the Data Source value.
    builder.Item("Data Source") = "NewOracleDemo"

    Console.WriteLine(builder.ConnectionString)
    Console.WriteLine()
    Console.WriteLine("Press Enter to continue.")
    Console.ReadLine()
  End Sub
End Module

Remarks

Because the OracleConnectionStringBuilder contains a fixed-size dictionary, trying to add a key that does not exist within the dictionary throws a KeyNotFoundException. The following table lists all the possible keys within the connection string, and the default value for each.

Key Property Default value
Data Source (or server) DataSource Empty string
Persist Security Info (or persistsecurityinfo) PersistSecurityInfo False
Integrated Security IntegratedSecurity False
User ID (or user or uid) UserID Empty string
Password Password Empty string
Enlist Enlist True
Pooling Pooling True
Min Pool Size MinPoolSize 0
Max Pool Size MaxPoolSize 100
Omit Oracle Connection Name OmitOracleConnectionName False
Unicode Unicode False
Load Balance Timeout (or connection lifetime) LoadBalanceTimeout 0

Applies to

See also