Export (0) Print
Expand All

FileSystemTask Class

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

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)

[GuidAttribute("07DE94E0-7D49-4F29-B02F-F5EECB93718D")]
public sealed class FileSystemTask : Task, 
	IDTSFileSystemTask, IDTSBreakpointSite, IDTSSuspend, IDTSComponentPersist

The FileSystemTask type exposes the following members.

  NameDescription
Public methodFileSystemTaskInitializes a new instance of the FileSystemTask class.
Top

  NameDescription
Public propertyAttributesGets or sets the attributes to apply to the file or directory.
Public propertyDebugModeA Boolean indicating if a task should check if breakpoints are enabled.
Public propertyDestinationGets or sets the destination folder or file.
Public propertyExecutionValueReturns the number of successful operations performed by the task. This field is read-only. (Overrides Task.ExecutionValue.)
Public propertyIsDestinationPathVariableGets or sets a Boolean that indicates whether Destination information is located in a package variable.
Public propertyIsSourcePathVariableGets or sets a Boolean that indicates whether Source information is located in a package variable.
Public propertyOperationGets or sets a value from the DTSFileSystemOperation enumeration that determines the type of operation to perform.
Public propertyOperationNameGets or sets the name of the task.
Public propertyOverwriteDestinationFileGets or sets a Boolean that indicates whether the task will overwrite destination files.
Public propertyPreservedAttributesGets or sets the Data Transformation Services preserved attributes.
Public propertySourceGets 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.
Public propertySuspendRequiredGets 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.
Public propertyVersion*** Member deprecated; see Remarks. ***   Returns the version of the task. This property is read-only. (Inherited from Task.)
Top

  NameDescription
Public methodAcceptBreakpointManagerPasses a BreakpointManager to the task. This method is called by the runtime and is not used in code.
Public methodCanUpdate*** Member deprecated; see Remarks. ***   A Boolean that indicates whether the new package XML can update the old package XML. (Inherited from Task.)
Public methodEqualsDetermines whether two object instances are equal. (Inherited from DtsObject.)
Public methodExecuteRuns the task. (Overrides Task.Execute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object).)
Public methodGetConnectionIDGets a String containing the ID of the connection. (Inherited from Task.)
Public methodGetConnectionNameGets a String containing the name of the connection. (Inherited from Task.)
Public methodGetHashCodeReturns the hash code for this instance. (Inherited from DtsObject.)
Public methodGetType (Inherited from Object.)
Public methodInitializeTaskInitializes 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).)
Public methodLoadFromXMLThis 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.
Public methodResumeExecutionResumes execution of the task after pausing. The task or container is resumed by the runtime engine.
Public methodSaveToXMLThis method is not callable by your application code. To save a package as .xml, use the Application.SaveToXml method.
Public methodSuspendExecutionIndicates that the executable needs to suspend. This method is called by the runtime engine.
Public methodToString (Inherited from Object.)
Public methodUpdate*** 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.)
Public methodValidateVerifies that the task is properly configured. (Overrides Task.Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging).)
Top

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

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft