Export (0) Print
Expand All

OracleConnectionStringBuilder.Item Property

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

Namespace:  System.Data.OracleClient
Assembly:  System.Data.OracleClient (in System.Data.OracleClient.dll)

'Declaration
Public Overrides Property Item ( _
	keyword As String _
) As Object

Parameters

keyword
Type: System.String
The key of the item to get or set.

Property Value

Type: System.Object
The value associated with the specified key.

ExceptionCondition
ArgumentNullException

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

KeyNotFoundException

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

FormatException

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

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

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.
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


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Community Additions

ADD
Show:
© 2014 Microsoft