EntityConnectionStringBuilder.Remove Method (String)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

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

Namespace:   System.Data.EntityClient
Assembly:  System.Data.Entity (in System.Data.Entity.dll)

Public Overrides Function Remove (
	keyword As String
) As Boolean

Parameters

keyword
Type: System.String

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

Return Value

Type: System.Boolean

Returns true if the key existed in the connection string and was removed; false if the key did not exist.

Exception Condition
ArgumentNullException

keyword is null (Nothing in Visual Basic)

Because the Remove method returns a value that indicates its success, it is not required to look for a key before trying to remove the keyword/value pair from the EntityConnectionStringBuilder instance.

.NET Framework
Available since 3.5
Return to top
Show: