Move Class

Definition

Task to move one or more files.

public ref class Move : Microsoft::Build::Tasks::TaskExtension, Microsoft::Build::Framework::ICancelableTask
public ref class Move : Microsoft::Build::Tasks::TaskExtension
public class Move : Microsoft.Build.Tasks.TaskExtension, Microsoft.Build.Framework.ICancelableTask
public class Move : Microsoft.Build.Tasks.TaskExtension
type Move = class
    inherit TaskExtension
    interface ICancelableTask
    interface ITask
type Move = class
    inherit TaskExtension
Public Class Move
Inherits TaskExtension
Implements ICancelableTask
Public Class Move
Inherits TaskExtension
Inheritance
Implements

Remarks

This does not support moving directories (ie, xcopy)

but this could restriction could be lifted as MoveFileEx,

which is used here, supports it.

Constructors

Move()

Creates a task to move one or more files.

Properties

BuildEngine

The build engine automatically sets this property to allow tasks to call back into it.

(Inherited from Task)
BuildEngine2

The build engine automatically sets this property to allow tasks to call back into it. This is a convenience property so that task authors inheriting from this class do not have to cast the value from IBuildEngine to IBuildEngine2.

(Inherited from Task)
BuildEngine3

Retrieves the IBuildEngine3 version of the build engine interface provided by the host.

(Inherited from Task)
BuildEngine4

Retrieves the IBuildEngine4 version of the build engine interface provided by the host.

(Inherited from Task)
BuildEngine5

Retrieves the IBuildEngine5 version of the build engine interface provided by the host.

(Inherited from Task)
BuildEngine6

Retrieves the IBuildEngine6 version of the build engine interface provided by the host.

(Inherited from Task)
DestinationFiles

Destination files matching each of the source files.

DestinationFolder

Destination folder for all the source files.

HelpKeywordPrefix

Gets or sets the prefix used to compose help keywords from string resource names. If a task does not have help keywords associated with its messages, it can ignore this property or set it to null. If the prefix is set to an empty string, then string resource names will be used verbatim as help keywords. For an example of how this prefix is used, see the TaskLoggingHelper.LogErrorWithCodeFromResources(string, object[]) method.

(Inherited from Task)
HostObject

The build engine sets this property if the host IDE has associated a host object with this particular task.

(Inherited from Task)
Log

Gets an instance of a TaskLoggingHelperExtension class containing task logging methods.

(Inherited from TaskExtension)
MovedFiles

Subset that were successfully moved

OverwriteReadOnlyFiles

Whether to overwrite files in the destination that have the read-only attribute set. Default is to not overwrite.

SourceFiles

List of files to move.

TaskResources

Gets or sets the task's culture-specific resources. Derived classes should register their resources either during construction, or via this property, if they have localized strings.

(Inherited from Task)

Methods

Cancel()

Stop and return (in an undefined state) as soon as possible.

Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
Execute()

Main entry point.

GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetType()

Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
ToString()

Returns a string that represents the current object.

(Inherited from Object)

Applies to