FileSystemTask FileSystemTask FileSystemTask Class

Definition

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

public ref class FileSystemTask sealed : Microsoft::SqlServer::Dts::Runtime::Task, Microsoft::SqlServer::Dts::Runtime::IDTSBreakpointSite, Microsoft::SqlServer::Dts::Runtime::IDTSComponentPersist, Microsoft::SqlServer::Dts::Tasks::FileSystemTask::IDTSFileSystemTask
[Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.filesystemtask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.FileSystemTask.Localized), SamplesTag="SsisFileSystemTask", TaskContact="File System Task;Microsoft Corporation; SQL Server 2017; © 2017 Microsoft Corporation; All Rights Reserved;http://www.microsoft.com/sql/support/default.asp;1", TaskType="DTS90", UITypeName="Microsoft.SqlServer.Dts.Tasks.FileSystemTask.FileSystemTaskUI, Microsoft.SqlServer.FileSystemTaskUI, Version=14.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")]
[System.Runtime.InteropServices.Guid("1D25A237-FC96-4421-ADDC-19BDD92E3139")]
public sealed class FileSystemTask : Microsoft.SqlServer.Dts.Runtime.Task, Microsoft.SqlServer.Dts.Runtime.IDTSBreakpointSite, Microsoft.SqlServer.Dts.Runtime.IDTSComponentPersist, Microsoft.SqlServer.Dts.Tasks.FileSystemTask.IDTSFileSystemTask
Public NotInheritable Class FileSystemTask
Inherits Task
Implements IDTSBreakpointSite, IDTSComponentPersist, IDTSFileSystemTask
Inheritance
FileSystemTaskFileSystemTaskFileSystemTask
Attributes
Implements

Remarks

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

Constructors

FileSystemTask() FileSystemTask() FileSystemTask()

Initializes a new instance of the FileSystemTask class.

Properties

Attributes Attributes Attributes

Gets or sets the attributes to apply to the file or directory.

DebugMode DebugMode DebugMode

A Boolean indicating if a task should check if breakpoints are enabled.

Destination Destination Destination

Gets or sets the destination folder or file.

ExecutionValue ExecutionValue ExecutionValue

Returns the number of successful operations performed by the task. This field is read-only.

IsDestinationPathVariable IsDestinationPathVariable IsDestinationPathVariable

Gets or sets a Boolean that indicates whether Destination information is located in a package variable.

IsSourcePathVariable IsSourcePathVariable IsSourcePathVariable

Gets or sets a Boolean that indicates whether Source information is located in a package variable.

Operation Operation Operation

Gets or sets a value from the DTSFileSystemOperation enumeration that determines the type of operation to perform.

OperationName OperationName OperationName

Gets or sets the name of the task.

OverwriteDestinationFile OverwriteDestinationFile OverwriteDestinationFile

Gets or sets a Boolean that indicates whether the task will overwrite destination files.

PreservedAttributes PreservedAttributes PreservedAttributes

Gets or sets the Data Transformation Services preserved attributes.

Source Source 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 SuspendRequired 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.

TargetServerVersion TargetServerVersion TargetServerVersion Inherited from Task
Version Version Version

\* Member deprecated; see Remarks. ***** Returns the version of the task. This property is read-only.

(Inherited from Task)

Methods

AcceptBreakpointManager(BreakpointManager) AcceptBreakpointManager(BreakpointManager) AcceptBreakpointManager(BreakpointManager)

Passes a BreakpointManager to the task. This method is called by the runtime and is not used in code.

CanUpdate(String) CanUpdate(String) CanUpdate(String)

\* Member deprecated; see Remarks. ***** A Boolean that indicates whether the new package XML can update the old package XML.

(Inherited from Task)
Equals(Object) Equals(Object) Equals(Object)

Determines whether two object instances are equal.

(Inherited from DtsObject)
Execute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object) Execute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object) Execute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object)

Runs the task.

GetConnectionID(Connections, String) GetConnectionID(Connections, String) GetConnectionID(Connections, String)

Gets a String containing the ID of the connection.

(Inherited from Task)
GetConnectionName(Connections, String) GetConnectionName(Connections, String) GetConnectionName(Connections, String)

Gets a String containing the name of the connection.

(Inherited from Task)
GetHashCode() GetHashCode() GetHashCode()

Returns the hash code for this instance.

(Inherited from DtsObject)
InitializeTask(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging, EventInfos, LogEntryInfos, ObjectReferenceTracker) InitializeTask(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging, EventInfos, LogEntryInfos, ObjectReferenceTracker) InitializeTask(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging, EventInfos, LogEntryInfos, ObjectReferenceTracker)

Initializes the properties associated with the task. This method is called by the runtime and is not used in code.

LoadFromXML(XmlElement, IDTSInfoEvents) LoadFromXML(XmlElement, IDTSInfoEvents) LoadFromXML(XmlElement, IDTSInfoEvents)

This method is not callable by your application code. To load a package that is saved as .xml to the hard drive, use the LoadPackage(String, IDTSEvents) method.

ResumeExecution() ResumeExecution() ResumeExecution()

Resumes execution of the task after pausing. The task or container is resumed by the runtime engine.

SaveToXML(XmlDocument, IDTSInfoEvents) SaveToXML(XmlDocument, IDTSInfoEvents) SaveToXML(XmlDocument, IDTSInfoEvents)

This method is not callable by your application code. To save a package as .xml, use the SaveToXml(String, Package, IDTSEvents) method.

SuspendExecution() SuspendExecution() SuspendExecution()

Indicates that the executable needs to suspend. This method is called by the runtime engine.

Update(String) Update(String) Update(String)

\* Member deprecated; see Remarks. ***** This method updates the old package XML with the new package XML if CanUpdate(String) is set to true.

(Inherited from Task)
Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging) Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging) Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging)

Verifies that the task is properly configured.

Applies to