Export (0) Print
Expand All

OracleConnectionStringBuilder.Remove Method

Removes the entry with the specified key from the OracleConnectionStringBuilder instance.

Namespace: System.Data.OracleClient
Assembly: System.Data.OracleClient (in system.data.oracleclient.dll)

'Declaration
Public Overrides Function Remove ( _
	keyword As String _
) As Boolean
'Usage
Dim instance As OracleConnectionStringBuilder
Dim keyword As String
Dim returnValue As Boolean

returnValue = instance.Remove(keyword)
public boolean Remove (
	String keyword
)
public override function Remove (
	keyword : String
) : boolean
Not applicable.

Parameters

keyword

The key of the key/value pair to be removed from the connection string in this OracleConnectionStringBuilder.

Return Value

true if the key existed within the connection string and was removed, false if the key did not exist.

Exception typeCondition

ArgumentNullException

keyword is null (Nothing in Visual Basic).

Because the Remove method returns a value that indicates its success, it is not necessary to look for the existence of a key before trying to remove the key/value pair from the OracleConnectionStringBuilder instance. Because the OracleConnectionStringBuilder maintains a fixed-size collection of key/value pairs, calling the Remove method just resets the value of the key/value pair back to its default value.

Because the collection of keys supported by the OracleConnectionStringBuilder is fixed, every item within the collection has a known default value.

The following table lists the keys, and the value for each when the OracleConnectionStringBuilder is first initialized, or after the Remove method has been called:

Key

Default value

Data Source

Empty string

Persist Security Info

False

Integrated Security

False

User ID

Empty string

Password

Empty string

Enlist

True

Pooling

True

Min Pool Size

0

Max Pool Size

100

Unicode

False

Load Balance Timeout

0

Omit Oracle Connection Name

False

The following example converts an existing connection string from using Windows Authentication to using integrated security. The example works by removing the user name and password from the connection string, and then setting the IntegratedSecurity property of the OracleConnectionStringBuilder object.

NoteNote:

This example includes a password to demonstrate how OracleConnectionStringBuilder works with connection strings. In your applications, we recommend that you use Windows Authentication. If you must use a password, do not include a hard-coded password in your application.

' 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()
    Try
      Dim connectString As String = _
       "Data Source=OracleDemo;User ID=Mary;Password=*****;"

      Dim builder As New OracleConnectionStringBuilder(connectString)
      Console.WriteLine("Original: " & builder.ConnectionString)

      ' Use the Remove method
      ' in order to reset the user ID and password back to their
      ' default (empty string) values.
      builder.Remove("User ID")
      builder.Remove("Password")

      ' Turn on integrated security.
      builder.IntegratedSecurity = True

      Console.WriteLine("Modified: " & builder.ConnectionString)

    Catch ex As Exception
      Console.WriteLine(ex.Message)
    End Try

    Console.WriteLine("Press any key to finish.")
    Console.ReadLine()
  End Sub
End Module

Windows 98, Windows Server 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0

Community Additions

ADD
Show:
© 2014 Microsoft