EntityConnectionStringBuilder.Remove(String) Method

Reference

Definition

Namespace:: System.Data.EntityClient

Assembly:: System.Data.Entity.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public:
 override bool Remove(System::String ^ keyword);

public override bool Remove (string keyword);

override this.Remove : string -> bool

Public Overrides Function Remove (keyword As String) As Boolean

Parameters

keyword: String

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

Returns

Boolean

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

Exceptions

ArgumentNullException

keyword is null (Nothing in Visual Basic)

Remarks

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.

Applies to