Share via

  • Article

FileSystemTask Members

Include Protected Members
Include Inherited Members

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

The FileSystemTask type exposes the following members.

Constructors

  Name Description
Public method FileSystemTask() Initializes a new instance of the FileSystemTask class.

Top

Methods

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

Top

Properties

  Name Description
Public property Attributes Gets or sets the attributes to apply to the file or directory.
Public property DebugMode A Boolean indicating if a task should check if breakpoints are enabled.
Public property Destination Gets or sets the destination folder or file.
Public property ExecutionValue Returns the number of successful operations performed by the task. This field is read-only. (Overrides Task.ExecutionValue.)
Public property IsDestinationPathVariable Gets or sets a Boolean that indicates whether Destination information is located in a package variable.
Public property IsSourcePathVariable Gets or sets a Boolean that indicates whether Source information is located in a package variable.
Public property Operation Gets or sets a value from the DTSFileSystemOperation enumeration that determines the type of operation to perform.
Public property OperationName Gets or sets the name of the task.
Public property OverwriteDestinationFile Gets or sets a Boolean that indicates whether the task will overwrite destination files.
Public property 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.
Public property 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.
Public property Version *** Member deprecated; see Remarks. ***    Returns the version of the task. This property is read-only. (Inherited from Task.)

Top