This documentation is archived and is not being maintained.

Get Class

Namespace:  Microsoft.TeamFoundation.Build.Tasks
Assembly:  Microsoft.TeamFoundation.Build.ProcessComponents (in Microsoft.TeamFoundation.Build.ProcessComponents.dll)

public class Get : WorkflowTask

The Get type exposes the following members.

  NameDescription
Public methodGet
Top

  NameDescription
Public propertyAllowUnmapped
Public propertyAutoMerge
Public propertyBuildAgentUriProperty that gives the Uri of the Build Agent (Inherited from WorkflowTask.)
Public propertyBuildDirectory
Public propertyBuildEngineITask implementation—BuildEngine property. (Inherited from Task.)
Public propertyBuildUriProperty 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.)
Public propertyDeletesThe list of all items that were deleted from the workspace.
Protected propertyExtensions (Inherited from WorkflowTask.)
Public propertyFilespecThe local path file specification that should be retrieved.
Public propertyForceForces 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.
Public propertyGetsThe list of all items that did not occur in the workspace.
Public propertyHostObjectITask implementation—HostObject property. (Inherited from Task.)
Public propertyNoCIOption
Public propertyOverwriteThis option provides the ability to overwrite writable files without forcing a get of the complete workspace.
Public propertyPopulateOutputA Boolean that controls whether the output properties—Gets, Replaces, Deletes—are populated.
Public propertyPreviewWhen set to true, no files are actually downloaded; instead, events are fired that show what files would have been downloaded.
Public propertyRecursiveRetrieves Filespec recursively.
Public propertyReplacesThe list of all items that were replaced in the workspace.
Public propertyTeamFoundationServerUrlProperty that gives the URL of the Team Foundation Server. (Inherited from Task.)
Protected propertyTfsLazy [init] property that gives access to the Team Foundation Server. (Inherited from Task.)
Public propertyVersionThe version specifier that will be used to pick the correct versions of files to retrieve into the local workspace.
Public propertyWarningsThe list of warnings encountered during the Get operation.
Public propertyWorkspaceThe name of the workspace.
Top

  NameDescription
Public methodEqualsDetermines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodExecuteITask implementation - Execute method. (Inherited from Task.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Protected methodGetParameterLog (Inherited from Task.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodLogCustomEventHelper to log a custom event if the task is running within MSBuild. (Inherited from Task.)
Protected methodLogErrorHelper to log an error string if the task is running within MSBuild. (Inherited from Task.)
Protected methodLogErrorEventHelper to log an error event if the task is running within MSBuild. (Inherited from Task.)
Protected methodLogMessage(String)Helper to log a message string if the task is running within MSBuild. (Inherited from Task.)
Protected methodLogMessage(String, MessageImportance)Helper to log a message string if the task is running within MSBuild. (Inherited from Task.)
Protected methodLogMessageEventHelper to log a message event if the task is running within MSBuild. (Inherited from Task.)
Protected methodLogWarningHelper to log a warning string if the task is running within MSBuild. (Inherited from Task.)
Protected methodLogWarningEventHelper to log a warning event if the task is running within MSBuild. (Inherited from Task.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

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