SharedResourceScope Class

Article
07/02/2014

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

Inheritance Hierarchy

System.Object
System.Activities.Activity
Microsoft.TeamFoundation.Build.Workflow.Activities.SharedResourceScope

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

Syntax

'Declaration
<ActivityTrackingAttribute(ActivityTrackingOption.ActivityOnly)> _
<BuildCategoryAttribute> _
<ContentPropertyAttribute("Activities")> _
<ToolboxBitmapAttribute(GetType(TeamBuildBaseActivityDesigner), "SharedResourceScopeIcon.png")> _
Public NotInheritable Class SharedResourceScope _
    Inherits Activity

[ActivityTrackingAttribute(ActivityTrackingOption.ActivityOnly)]
[BuildCategoryAttribute]
[ContentPropertyAttribute("Activities")]
[ToolboxBitmapAttribute(typeof(TeamBuildBaseActivityDesigner), "SharedResourceScopeIcon.png")]
public sealed class SharedResourceScope : Activity

[ActivityTrackingAttribute(ActivityTrackingOption::ActivityOnly)]
[BuildCategoryAttribute]
[ContentPropertyAttribute(L"Activities")]
[ToolboxBitmapAttribute(typeof(TeamBuildBaseActivityDesigner), L"SharedResourceScopeIcon.png")]
public ref class SharedResourceScope sealed : public Activity

[<Sealed>]
[<ActivityTrackingAttribute(ActivityTrackingOption.ActivityOnly)>]
[<BuildCategoryAttribute>]
[<ContentPropertyAttribute("Activities")>]
[<ToolboxBitmapAttribute(typeof(TeamBuildBaseActivityDesigner), "SharedResourceScopeIcon.png")>]
type SharedResourceScope =  
    class 
        inherit Activity 
    end

public final class SharedResourceScope extends Activity

The SharedResourceScope type exposes the following members.

Constructors

	Name	Description
	SharedResourceScope	Initializes a new instance of the SharedResourceScope class.

Top

Properties

	Name	Description
	Activities	Gets a collection of activities contained within this scope.
	CacheId	Gets the identifier of the cache that is unique within the scope of the workflow definition. (Inherited from Activity.)
	DisplayName	Gets or sets an optional friendly name that is used for debugging, validation, exception handling, and tracking. (Inherited from Activity.)
	Id	Gets an identifier that is unique in the scope of the workflow definition. (Inherited from Activity.)
	MaxExecutionTime	Gets or sets the maximum amount of time to wait for this activity to be completed.
	MaxWaitTime	Gets or sets the maximum amount of time to wait for this activity to be executed while in the build queue.
	ResourceName	Gets or sets the name of the shared resource.
	Variables	Gets or sets a collection of variables used by the shared resource.

Top

Methods

	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	ShouldSerializeDisplayName	Indicates whether the DisplayName property should be serialized. (Inherited from Activity.)
	ToString	Returns a String that contains the Id and DisplayName of the Activity. (Inherited from Activity.)

Top

Extension Methods

	Name	Description
	GetAssemblyMetadataCollection	(Defined by WorkflowHelpers.)

Top

Remarks

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.

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.