Get Class
Inheritance Hierarchy
System.Object
Microsoft.TeamFoundation.Build.Tasks.Task
Microsoft.TeamFoundation.Build.Tasks.WorkflowTask
Microsoft.TeamFoundation.Build.Tasks.Get
Namespace: Microsoft.TeamFoundation.Build.Tasks
Assembly: Microsoft.TeamFoundation.Build.ProcessComponents (in Microsoft.TeamFoundation.Build.ProcessComponents.dll)
Syntax
'Declaration
Public Class Get _
Inherits WorkflowTask
public class Get : WorkflowTask
public ref class Get : public WorkflowTask
type Get =
class
inherit WorkflowTask
end
public class Get extends WorkflowTask
The Get type exposes the following members.
Constructors
Name | Description | |
---|---|---|
Get |
Top
Properties
Name | Description | |
---|---|---|
AllowUnmapped | ||
AutoMerge | ||
BuildAgentUri | (Inherited from WorkflowTask.) | |
BuildDirectory | ||
BuildEngine | ITask implementation—[BuildEngine] property. (Inherited from Task.) | |
BuildUri | Property that gives the URI of the build for which this task is executing. Derived classes can override this property to make it required. (Inherited from Task.) | |
Deletes | The list of all items that were deleted from the workspace. | |
Extensions | (Inherited from WorkflowTask.) | |
Filespec | The local path file specification that should be retrieved. | |
Force | Forces all files to be retrieved, not just those that are out of date. This option also overwrites writable files on the local disk that are under version control but not checked out. | |
Gets | The list of all items that did not occur in the workspace. | |
HostObject | ITask implementation—[HostObject] property. (Inherited from Task.) | |
NoCIOption | ||
Overwrite | This option provides the ability to overwrite writable files without forcing a get of the complete workspace. | |
PopulateOutput | A Boolean that controls whether the output properties—Gets, Replaces, Deletes—are populated. | |
Preview | When set to true, no files are actually downloaded; instead, events are fired that show what files would have been downloaded. | |
Recursive | Retrieves [Filespec] recursively. | |
Replaces | The list of all items that were replaced in the workspace. | |
TeamFoundationServerUrl | Property that gives the URL of the Team Foundation Server. (Inherited from Task.) | |
Tfs | Lazy [init] property that gives access to the Team Foundation Server. (Inherited from Task.) | |
Version | The version specifier that will be used to pick the correct versions of files to retrieve into the local workspace. | |
Warnings | The list of warnings encountered during the [Get] operation. | |
Workspace | The name of the workspace. |
Top
Methods
Name | Description | |
---|---|---|
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) | |
Execute | ITask implementation - Execute method. (Inherited from Task.) | |
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 | Serves as a hash function for a particular type. (Inherited from Object.) | |
GetParameterLog | (Inherited from Task.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
LogCustomEvent | Helper to log a custom event if the task is running within MSBuild. (Inherited from Task.) | |
LogError | Helper to log an error string if the task is running within MSBuild. (Inherited from Task.) | |
LogErrorEvent | Helper to log an error event if the task is running within MSBuild. (Inherited from Task.) | |
LogMessage(String) | Helper to log a message string if the task is running within MSBuild. (Inherited from Task.) | |
LogMessage(String, MessageImportance) | Helper to log a message string if the task is running within MSBuild. (Inherited from Task.) | |
LogMessageEvent | Helper to log a message event if the task is running within MSBuild. (Inherited from Task.) | |
LogWarning | Helper to log a warning string if the task is running within MSBuild. (Inherited from Task.) | |
LogWarningEvent | Helper to log a warning event if the task is running within MSBuild. (Inherited from Task.) | |
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
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.