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)

public override bool Remove(
	string keyword
)

Parameters

keyword
Type: System.String

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

Return Value

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

ExceptionCondition
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. 
using System.Data.OracleClient;

class Program
{
    static void Main()
    {
        try
        {
            string connectString =
                "Data Source=OracleDemo;User ID=Mary;Password=*****";

            OracleConnectionStringBuilder builder = 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 (Exception ex)
        {
            Console.WriteLine(ex.Message);
        }
        Console.WriteLine("Press any key to finish.");
        Console.ReadLine();
    }
}

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Show:
© 2014 Microsoft