This documentation is archived and is not being maintained.

SharedResourceScope Class

Represents an activity that wraps a segment of the build process to make it “thread safe”.


Namespace:  Microsoft.TeamFoundation.Build.Workflow.Activities
Assembly:  Microsoft.TeamFoundation.Build.Workflow (in Microsoft.TeamFoundation.Build.Workflow.dll)

[ToolboxBitmapAttribute(typeof(TeamBuildBaseActivityDesigner), "SharedResourceScopeIcon.png")]
public sealed class SharedResourceScope : Activity

The SharedResourceScope type exposes the following members.

Public methodSharedResourceScopeInitializes a new instance of the SharedResourceScope class.

Public propertyActivitiesGets a collection of activities contained within this scope.
Protected propertyCacheIdGets the identifier of the cache that is unique within the scope of the workflow definition. (Inherited from Activity.)
Public propertyDisplayNameGets or sets an optional friendly name that is used for debugging, validation, exception handling, and tracking. (Inherited from Activity.)
Public propertyIdGets an identifier that is unique in the scope of the workflow definition. (Inherited from Activity.)
Public propertyMaxExecutionTimeGets or sets the maximum amount of time to wait for this activity to be completed.
Public propertyMaxWaitTimeGets or sets the maximum amount of time to wait for this activity to be executed while in the build queue.
Public propertyResourceNameGets or sets the name of the shared resource.
Public propertyVariablesGets or sets a collection of variables used by the shared resource.

Public methodEqualsDetermines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodShouldSerializeDisplayNameIndicates whether the DisplayName property should be serialized. (Inherited from Activity.)
Public methodToStringReturns a String that contains the Id and DisplayName of the Activity. (Inherited from Activity.)

A typical use of this activity is to enclose inside it the parts of a build process that must access a shared resource that must be accessed by only one process at a time. For example, you want your builds to write, in sequential order, to a single text file on a file share. To make sure that this kind of process functions correctly, you should implement it inside a SharedResourceScope activity.

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