FileSystemTask Class

 

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

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

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

[<Sealed>]
[<GuidAttribute("E5857CB6-FC91-45AD-8BB8-01E25D229BD6")>]
type FileSystemTask = 
    class
        inherit Task
        interface IDTSFileSystemTask
        interface IDTSBreakpointSite
        interface IDTSSuspend
        interface IDTSComponentPersist
    end

NameDescription
System_CAPS_pubmethodFileSystemTask()

Initializes a new instance of the FileSystemTask class.

NameDescription
System_CAPS_pubpropertyAttributes

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

System_CAPS_pubpropertyDebugMode

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

System_CAPS_pubpropertyDestination

Gets or sets the destination folder or file.

System_CAPS_pubpropertyExecutionValue

Returns the number of successful operations performed by the task. This field is read-only.(Overrides Task.ExecutionValue.)

System_CAPS_pubpropertyIsDestinationPathVariable

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

System_CAPS_pubpropertyIsSourcePathVariable

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

System_CAPS_pubpropertyOperation

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

System_CAPS_pubpropertyOperationName

Gets or sets the name of the task.

System_CAPS_pubpropertyOverwriteDestinationFile

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

System_CAPS_pubpropertyPreservedAttributes

Gets or sets the Data Transformation Services preserved attributes.

System_CAPS_pubpropertySource

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.

System_CAPS_pubpropertySuspendRequired

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.

System_CAPS_pubpropertyTargetServerVersion

(Inherited from Task.)

System_CAPS_pubpropertyVersion

*** Member deprecated; see Remarks. ***   Returns the version of the task. This property is read-only.(Inherited from Task.)

NameDescription
System_CAPS_pubmethodAcceptBreakpointManager(BreakpointManager)

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

System_CAPS_pubmethodCanUpdate(String)

*** Member deprecated; see Remarks. ***   A Boolean that indicates whether the new package XML can update the old package XML.(Inherited from Task.)

System_CAPS_pubmethodEquals(Object)

Determines whether two object instances are equal.(Inherited from DtsObject.)

System_CAPS_pubmethodExecute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object)
System_CAPS_pubmethodGetConnectionID(Connections, String)

Gets a String containing the ID of the connection.(Inherited from Task.)

System_CAPS_pubmethodGetConnectionName(Connections, String)

Gets a String containing the name of the connection.(Inherited from Task.)

System_CAPS_pubmethodGetHashCode()

Returns the hash code for this instance.(Inherited from DtsObject.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodInitializeTask(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.(Overrides Task.InitializeTask(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging, EventInfos, LogEntryInfos, ObjectReferenceTracker).)

System_CAPS_pubmethodLoadFromXML(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 Application.LoadPackage method.

System_CAPS_pubmethodResumeExecution()

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

System_CAPS_pubmethodSaveToXML(XmlDocument, IDTSInfoEvents)

This method is not callable by your application code. To save a package as .xml, use the Application.SaveToXml method.

System_CAPS_pubmethodSuspendExecution()

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

System_CAPS_pubmethodToString()

(Inherited from Object.)

System_CAPS_pubmethodUpdate(String)

*** 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.)

System_CAPS_pubmethodValidate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging)

Verifies that the task is properly configured.(Overrides Task.Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging).)

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.

Return to top
Show: