TimeoutAttribute Class

Definition

Namespace:

Microsoft.VisualStudio.TestTools.UnitTesting

Assembly:

Microsoft.VisualStudio.TestPlatform.TestFramework.dll

Package:

MSTest.TestFramework v3.8.0

Source:

TimeoutAttribute.cs

Timeout attribute; used to specify the timeout of a unit test.

C++

public ref class TimeoutAttribute sealed : Attribute

Inheritance

Attribute

TimeoutAttribute

Attributes

AttributeUsageAttribute

Constructors

TimeoutAttribute(Int32)	Initializes a new instance of the TimeoutAttribute class.
TimeoutAttribute(TestTimeout)	Initializes a new instance of the TimeoutAttribute class with a preset timeout.

Properties

CooperativeCancellation

Gets or sets a value indicating whether the test method should be cooperatively canceled on timeout. When set to true, the cancellation token is canceled on timeout, and the method completion is awaited. The test method and all the code it calls, must be designed in a way that it observes the cancellation and cancels cooperatively. If the test method does not complete, the timeout does not force it to complete. When set to false, the cancellation token is canceled on timeout, timeout result is reported and the method task will continue running on background. This may lead to conflicts in file access on test cleanup, unobserved exceptions, and memory leaks.

Timeout

Gets the timeout in milliseconds.

Applies to