This documentation is archived and is not being maintained.

LoadTestScenario.LoadProfile Property

Gets or sets the profile of the user load for this scenario.

Namespace:  Microsoft.VisualStudio.TestTools.LoadTesting
Assembly:  Microsoft.VisualStudio.QualityTools.LoadTestFramework (in Microsoft.VisualStudio.QualityTools.LoadTestFramework.dll)

public LoadTestLoadProfile LoadProfile { get; set; }

Property Value

Type: Microsoft.VisualStudio.TestTools.LoadTesting.LoadTestLoadProfile
The profile of the user load.

Changes to the LoadProfile property take effect just before the next Heartbeat event after the new LoadProfile from the controller has been received by the agent. A Heartbeat event occurs every second.

You can assign values to the LoadProfile property of LoadTestScenario in the Initialize() method or in any of the LoadTestPlugin event handlers. However, it is pointless to assign a value to this property in the LoadTestFinished event handler.

In a multi-agent test rig, a Load Test Plug-In that is running on any of the agents can change the value of the LoadProfile property. In this case, those changes are propagated to all other agents through the controller.

If plug-ins that are running on different agents all change the LoadProfile property, the last agent to change the value will override the previous value on all agents. Typically, the changes are applied in seconds on all agents. However, especially when you use a large number of agents, some agents might begin to use the new settings before other agents.