ClassCleanupAttribute Class
TOC
Collapse the table of content
Expand the table of content

ClassCleanupAttribute Class

 

Identifies a method that contains code to be used after all the tests in the test class have run and to free resources obtained by the test class. This class cannot be inherited.

Namespace:   Microsoft.VisualStudio.TestTools.UnitTesting
Assembly:  Microsoft.VisualStudio.QualityTools.UnitTestFramework (in Microsoft.VisualStudio.QualityTools.UnitTestFramework.dll)

System::Object
  System::Attribute
    Microsoft.VisualStudio.TestTools.UnitTesting::ClassCleanupAttribute

[AttributeUsageAttribute(AttributeTargets::Method, AllowMultiple = false)]
public ref class ClassCleanupAttribute sealed : Attribute

NameDescription
System_CAPS_pubmethodClassCleanupAttribute()

Initializes a new instance of the ClassCleanupAttribute class.

NameDescription
System_CAPS_pubpropertyTypeId

(Inherited from Attribute.)

NameDescription
System_CAPS_pubmethodEquals(Object^)

(Inherited from Attribute.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Attribute.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodIsDefaultAttribute()

(Inherited from Attribute.)

System_CAPS_pubmethodMatch(Object^)

(Inherited from Attribute.)

System_CAPS_pubmethodToString()

(Inherited from Object.)

The method marked with this attribute will be run after methods marked with the TestCleanupAttribute and before the method marked with AssemblyCleanupAttribute. Only one method in an class may be decorated with this attribute.

System_CAPS_importantImportant

This attribute should not be used on ASP.NET unit tests, that is, any test with [HostType("ASP.NET")] attribute. Because of the stateless nature of IIS and ASP.NET, a method decorated with this attribute might be called more than once per test run.

This attribute can be specified on a method. Only one instance of this attribute may be applied to a method.

For more information about how to use attributes, see Extending Metadata Using Attributes.

Legacy Code Example

The following examples demonstrate the initialization and clean-up attributes used to indicate which methods should be run by the test engine at different periods of the test.

The first code samples contain a class and method to test. To run this example, create a class library project and replace the code with the following example.

No code example is currently available or this language may not be supported.

The following example contains code to test DivideMethod() found in the previous code examples. Create a test project and put the following code in a test class document. Add the appropriate references to the project. This code contains attributes that control the initialization and clean-up execution order for the method, class, and assembly.

In particular, note the ClassCleanup attribute on the ClassCleanup()method.

No code example is currently available or this language may not be supported.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show:
© 2016 Microsoft