FtpTask Class

Article
04/26/2013

Downloads and uploads data files and manages directories on servers. This class cannot be inherited.

Inheritance Hierarchy

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

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

Syntax

'Declaration
<GuidAttribute("FA1E37FE-7A9A-406A-91DC-C3221F9945A2")> _
Public NotInheritable Class FtpTask _
    Inherits Task _
    Implements IDTSFTPTask, IDTSComponentPersist, IDTSBreakpointSite, IDTSSuspend
'Usage
Dim instance As FtpTask

[GuidAttribute("FA1E37FE-7A9A-406A-91DC-C3221F9945A2")]
public sealed class FtpTask : Task, 
    IDTSFTPTask, IDTSComponentPersist, IDTSBreakpointSite, IDTSSuspend

[GuidAttribute(L"FA1E37FE-7A9A-406A-91DC-C3221F9945A2")]
public ref class FtpTask sealed : public Task, 
    IDTSFTPTask, IDTSComponentPersist, IDTSBreakpointSite, IDTSSuspend

[<SealedAttribute>]
[<GuidAttribute("FA1E37FE-7A9A-406A-91DC-C3221F9945A2")>]
type FtpTask =  
    class 
        inherit Task 
        interface IDTSFTPTask 
        interface IDTSComponentPersist 
        interface IDTSBreakpointSite 
        interface IDTSSuspend 
    end

public final class FtpTask extends Task implements IDTSFTPTask, IDTSComponentPersist, IDTSBreakpointSite, IDTSSuspend

The FtpTask type exposes the following members.

Constructors

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

Top

Properties

	Name	Description
	Connection	Gets or sets the connection name of the FTP connection manager used by the task.
	DebugMode	Indicates whether a task should check if breakpoints are enabled.
	ExecutionValue	Returns a user-defined object. This property is read-only. (Overrides Task.ExecutionValue.)
	IsLocalPathVariable	Indicates whether the local path is stored in a variable or a FILE connection manager.
	IsRemotePathVariable	Indicates whether the remote path is stored in a variable.
	IsTransferTypeASCII	Indicates whether files transferred to and from the remote FTP server should be transferred in ASCII mode.
	LocalPath	Gets or sets the local path to use. The local path can refer to a FILE connection manager or a variable name.
	Operation	Gets or sets a value from the DTSFTPOp enumeration that indicates the FTP operation to perform.
	OperationName	Gets or sets a unique name for the File Transfer Protocol (FTP) task.
	OverwriteDestination	Specifies whether a file at the destination can be overwritten.
	RemotePath	Gets or sets the remote path to use.
	StopOnOperationFailure	Indicates whether the File Transfer Protocol (FTP) task terminates when the FTP operation fails.
	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 a 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 saved as .xml, 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 component is properly configured. (Overrides Task.Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging).)

Top

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