Partager via


DataConnectionProperties.Remove Method

Removes a property from the current connection property collection.

Namespace:  Microsoft.VisualStudio.Data.Framework
Assembly:  Microsoft.VisualStudio.Data.Framework (in Microsoft.VisualStudio.Data.Framework.dll)

Syntax

'Declaration
Public Function Remove ( _
    key As String _
) As Boolean
public bool Remove(
    string key
)
public:
virtual bool Remove(
    String^ key
) sealed
abstract Remove : 
        key:string -> bool  
override Remove : 
        key:string -> bool
public final function Remove(
    key : String
) : boolean

Parameters

  • key
    Type: System.String

    Name of the property to be removed from the current set.

Return Value

Type: System.Boolean
true if property is removed; false if the property is not found.

Implements

IDictionary<TKey, TValue>.Remove(TKey)

Exceptions

Exception Condition
ArgumentNullException

The key parameter is nulla null reference (Nothing in Visual Basic).

NotSupportedException

The data connection properties are not extensible.

ArgumentException

The property cannot be removed because it was not found in the list of extended properties.

Remarks

This method is called by Remove.

.NET Framework Security

See Also

Reference

DataConnectionProperties Class

Microsoft.VisualStudio.Data.Framework Namespace