FtpTask Class

Definition

Namespace:

Microsoft.SqlServer.Dts.Tasks.FtpTask

Assembly:

Microsoft.SqlServer.FtpTask.dll

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

public ref class FtpTask sealed : Microsoft::SqlServer::Dts::Runtime::Task, Microsoft::SqlServer::Dts::Runtime::IDTSBreakpointSite, Microsoft::SqlServer::Dts::Runtime::IDTSComponentPersist, Microsoft::SqlServer::Dts::Tasks::FtpTask::IDTSFTPTask

[Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.ftptask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.FtpTask.Localized), SamplesTag="SsisFtpTask", TaskContact="FTP Task; Microsoft Corporation; SQL Server 2019; (c) Microsoft Corporation; All Rights Reserved;http://www.microsoft.com/sql/support/default.asp;1", TaskType="DTS90", UITypeName="Microsoft.SqlServer.Dts.Tasks.FtpTask.FTPTaskUI, Microsoft.SqlServer.FTPTaskUI, Version=15.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")]
[System.Runtime.InteropServices.Guid("053C6358-D2FA-4D81-B0C3-3B25BB2680C4")]
public sealed class FtpTask : Microsoft.SqlServer.Dts.Runtime.Task, Microsoft.SqlServer.Dts.Runtime.IDTSBreakpointSite, Microsoft.SqlServer.Dts.Runtime.IDTSComponentPersist, Microsoft.SqlServer.Dts.Tasks.FtpTask.IDTSFTPTask

[<Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.ftptask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.FtpTask.Localized), SamplesTag="SsisFtpTask", TaskContact="FTP Task; Microsoft Corporation; SQL Server 2019; (c) Microsoft Corporation; All Rights Reserved;http://www.microsoft.com/sql/support/default.asp;1", TaskType="DTS90", UITypeName="Microsoft.SqlServer.Dts.Tasks.FtpTask.FTPTaskUI, Microsoft.SqlServer.FTPTaskUI, Version=15.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")>]
[<System.Runtime.InteropServices.Guid("053C6358-D2FA-4D81-B0C3-3B25BB2680C4")>]
type FtpTask = class
    inherit Task
    interface IDTSFTPTask
    interface IDTSComponentPersist
    interface IDTSBreakpointSite
    interface IDTSSuspend

Public NotInheritable Class FtpTask
Inherits Task
Implements IDTSBreakpointSite, IDTSComponentPersist, IDTSFTPTask

Inheritance

Object

DtsObject

Task

FtpTask

Attributes

DtsTaskAttribute GuidAttribute

Implements

IDTSBreakpointSite IDTSComponentPersist IDTSSuspend IDTSFTPTask

Constructors

FtpTask()

Initializes a new instance of the FtpTask class.

Properties

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.
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.
TargetServerVersion	(Inherited from Task)
Version	*** Member deprecated; see Remarks. ***   Returns the version of the task. This property is read-only. (Inherited from Task)

Methods

AcceptBreakpointManager(BreakpointManager)	Passes a BreakpointManager to the task. This method is called by the runtime and is not used in code.
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)	Determines whether two object instances are equal. (Inherited from DtsObject)
Execute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object)	Runs the task.
GetConnectionID(Connections, String)	Gets a String containing the ID of the connection. (Inherited from Task)
GetConnectionName(Connections, String)	Gets a String containing the name of the connection. (Inherited from Task)
GetHashCode()	Returns the hash code for this instance. (Inherited from DtsObject)
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)	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()	Resumes execution of the task after pausing. The task or container is resumed by the runtime engine.
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()	Indicates that the executable needs to suspend. This method is called by the runtime engine.
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)	Verifies that the task is properly configured.