HostTypeAttribute Class (Microsoft.VisualStudio.TestTools.UnitTesting)

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2010/.NET Framework 4

Other versions are also available for the following:

API Reference for Testing Tools for Visual Studio ALM

HostTypeAttribute Class

Specifies the type of host on which the associated unit test will run. This class cannot be inherited.

Inheritance Hierarchy

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

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

Syntax

Visual Basic

<AttributeUsageAttribute(AttributeTargets.Method, AllowMultiple := False)> _
Public NotInheritable Class HostTypeAttribute _
    Inherits Attribute

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

Visual C++

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

[<Sealed>]
[<AttributeUsageAttribute(AttributeTargets.Method, AllowMultiple = false)>]
type HostTypeAttribute =  
    class
        inherit Attribute
    end

JScript

public final class HostTypeAttribute extends Attribute

The HostTypeAttribute type exposes the following members.

Constructors

	Name	Description
	HostTypeAttribute(String)	Initializes a new instance of the HostTypeAttribute class. This is instantiated by using an argument that specifies the type of host on which this unit test will run.
	HostTypeAttribute(String, String)	Initializes a new instance of the HostTypeAttribute class. This is instantiated by using an argument that specifies the type of host on which this unit test will run, and custom data for the host adapter.

Top

Properties

	Name	Description
	HostData	Gets custom data for the host adapter.
	HostType	Gets a value that represents the type of host.
	TypeId	When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)

Top

Methods

	Name	Description
	Equals	Infrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Returns the hash code for this instance. (Inherited from Attribute.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IsDefaultAttribute	When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.)
	Match	When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Explicit Interface Implementations

	Name	Description
	_Attribute..::.GetIDsOfNames	Maps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
	_Attribute..::.GetTypeInfo	Retrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
	_Attribute..::.GetTypeInfoCount	Retrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
	_Attribute..::.Invoke	Provides access to properties and methods exposed by an object. (Inherited from Attribute.)

Top

Remarks

The type of host identifies the test run on the host, outside the current environment. When a test is run in a different environment, it might also run in a different process. The following example shows that the test is being run in the ASP.NET Development Server address space. This is designated by the AspNetDevelopmentServerHostAttribute. Visual Studio 2005 includes one host adapter called ASP.NET. This is used for ASP.NET unit tests. Customers can create their own host adapters through Visual Studio Industry Partner (VSIP) program.

Note
The Visual Studio software development kit (SDK) contains a sample application named "VSIdeHostAdapter." As an example host adapter, it demonstrates how to create a host adapter that runs tests inside a Visual Studio process.

The HostTypeAttribute can be specified on a test method. Only a single instance of this attribute can occur on a method.

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

Examples

[TestMethod()]
[HostType("ASP.NET")]
[UrlToTest("http://localhost:1371/webSite12")]
[AspNetDevelopmentServerHost("d:\\MyWebSite", "/MyWebSiteRoot")]
public void ConstructorTest()
{
   object target = TestProject1.Class1Accessor.CreatePrivate();
   Assert.Inconclusive("TODO: Implement code to verify target");
}

Thread Safety

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

Reference

Microsoft.VisualStudio.TestTools.UnitTesting Namespace