FileSystemTask Class

Article
04/26/2013

Runs commands against the file system. This class cannot be inherited.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Dts.Runtime.DtsObject
    Microsoft.SqlServer.Dts.Runtime.Task
      Microsoft.SqlServer.Dts.Tasks.FileSystemTask.FileSystemTask

Namespace: Microsoft.SqlServer.Dts.Tasks.FileSystemTask
Assembly: Microsoft.SqlServer.FileSystemTask (in Microsoft.SqlServer.FileSystemTask.dll)

Syntax

'Declaration
<GuidAttribute("882ED50A-CCA5-427A-BB5D-2DC706DDD747")> _
Public NotInheritable Class FileSystemTask _
    Inherits Task _
    Implements IDTSFileSystemTask, IDTSBreakpointSite, IDTSSuspend, IDTSComponentPersist
'Usage
Dim instance As FileSystemTask

[GuidAttribute("882ED50A-CCA5-427A-BB5D-2DC706DDD747")]
public sealed class FileSystemTask : Task, 
    IDTSFileSystemTask, IDTSBreakpointSite, IDTSSuspend, IDTSComponentPersist

[GuidAttribute(L"882ED50A-CCA5-427A-BB5D-2DC706DDD747")]
public ref class FileSystemTask sealed : public Task, 
    IDTSFileSystemTask, IDTSBreakpointSite, IDTSSuspend, IDTSComponentPersist

[<SealedAttribute>]
[<GuidAttribute("882ED50A-CCA5-427A-BB5D-2DC706DDD747")>]
type FileSystemTask =  
    class 
        inherit Task 
        interface IDTSFileSystemTask 
        interface IDTSBreakpointSite 
        interface IDTSSuspend 
        interface IDTSComponentPersist 
    end

public final class FileSystemTask extends Task implements IDTSFileSystemTask, IDTSBreakpointSite, IDTSSuspend, IDTSComponentPersist

The FileSystemTask type exposes the following members.

Constructors

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

Top

Properties

	Name	Description
	Attributes	Gets or sets the attributes to apply to the file or directory.
	DebugMode	A Boolean indicating if a task should check if breakpoints are enabled.
	Destination	Gets or sets the destination folder or file.
	ExecutionValue	Returns the number of successful operations performed by the task. This field is read-only. (Overrides Task.ExecutionValue.)
	IsDestinationPathVariable	Gets or sets a Boolean that indicates whether Destination information is located in a package variable.
	IsSourcePathVariable	Gets or sets a Boolean that indicates whether Source information is located in a package variable.
	Operation	Gets or sets a value from the DTSFileSystemOperation enumeration that determines the type of operation to perform.
	OperationName	Gets or sets the name of the task.
	OverwriteDestinationFile	Gets or sets a Boolean that indicates whether the task will overwrite destination files.
	PreservedAttributes	Gets or sets the Data Transformation Services preserved attributes.
	Source	Gets or sets the source file or directory. If IsSourcePathVariable is set to true, gets or sets the package variable name representing the source file or directory.
	SuspendRequired	Gets or sets a Boolean that indicates if tasks should suspend when they encounter a breakpoint. This value is set by the runtime engine for tasks and containers when a breakpoint is encountered.
	Version	* Member deprecated; see Remarks. * Returns the version of the task. This property is read-only. (Inherited from Task.)

Top

Methods

	Name	Description
	AcceptBreakpointManager	Passes a BreakpointManager to the task. This method is called by the runtime and is not used in code.
	CanUpdate	* Member deprecated; see Remarks. * A Boolean that indicates whether the new package XML can update the old package XML. (Inherited from Task.)
	Equals	Determines whether two object instances are equal. (Inherited from DtsObject.)
	Execute	Runs the task. (Overrides Task.Execute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object).)
	GetConnectionID	Gets a String containing the ID of the connection. (Inherited from Task.)
	GetConnectionName	Gets a String containing the name of the connection. (Inherited from Task.)
	GetHashCode	Returns the hash code for this instance. (Inherited from DtsObject.)
	GetType	(Inherited from Object.)
	InitializeTask	Initializes the properties associated with the task. This method is called by the runtime and is not used in code. (Overrides Task.InitializeTask(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging, EventInfos, LogEntryInfos, ObjectReferenceTracker).)
	LoadFromXML	This method is not callable by your application code. To load a package that is saved as .xml to the hard drive, use the Application.LoadPackage method.
	ResumeExecution	Resumes execution of the task after pausing. The task or container is resumed by the runtime engine.
	SaveToXML	This method is not callable by your application code. To save a package as .xml, use the Application.SaveToXml method.
	SuspendExecution	Indicates that the executable needs to suspend. This method is called by the runtime engine.
	ToString	(Inherited from Object.)
	Update	* Member deprecated; see Remarks. * This method updates the old package XML with the new package XML if CanUpdate is set to true. (Inherited from Task.)
	Validate	Verifies that the task is properly configured. (Overrides Task.Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging).)

Top

Remarks

For information on the tasks that can be run with this task, see DTSFileSystemOperation.

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.

Share via