LoadTestContext.Remove Method (String)

Removes the element that has the specified key from the LoadTestContext.

Namespace:  Microsoft.VisualStudio.TestTools.LoadTesting
Assembly:  Microsoft.VisualStudio.QualityTools.LoadTestFramework (in Microsoft.VisualStudio.QualityTools.LoadTestFramework.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: String

    The key of the element to remove.

Return Value

Type: Boolean
true if the element is successfully removed; otherwise, false. This method also returns false if key was not found in the original LoadTestContext.

Implements

IDictionary.Remove(UTP)

Exceptions

Exception Condition
ArgumentNullException

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

NotSupportedException

LoadTestContext is read-only.

.NET Framework Security

See Also

Reference

LoadTestContext Class

Remove Overload

Microsoft.VisualStudio.TestTools.LoadTesting Namespace