Export (0) Print
Expand All

FtpTask Class

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

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)

[GuidAttribute("C23B9EC8-9F18-4E94-ABE6-98F229642C38")]
public sealed class FtpTask : Task, 
	IDTSFTPTask, IDTSComponentPersist, IDTSBreakpointSite, IDTSSuspend

The FtpTask type exposes the following members.

  NameDescription
Public methodFtpTaskInitializes a new instance of the FtpTask class.
Top

  NameDescription
Public propertyConnectionGets or sets the connection name of the FTP connection manager used by the task.
Public propertyDebugModeIndicates whether a task should check if breakpoints are enabled.
Public propertyExecutionValueReturns a user-defined object. This property is read-only. (Overrides Task.ExecutionValue.)
Public propertyIsLocalPathVariableIndicates whether the local path is stored in a variable or a FILE connection manager.
Public propertyIsRemotePathVariableIndicates whether the remote path is stored in a variable.
Public propertyIsTransferTypeASCIIIndicates whether files transferred to and from the remote FTP server should be transferred in ASCII mode.
Public propertyLocalPathGets or sets the local path to use. The local path can refer to a FILE connection manager or a variable name.
Public propertyOperationGets or sets a value from the DTSFTPOp enumeration that indicates the FTP operation to perform.
Public propertyOperationNameGets or sets a unique name for the File Transfer Protocol (FTP) task.
Public propertyOverwriteDestinationSpecifies whether a file at the destination can be overwritten.
Public propertyRemotePathGets or sets the remote path to use.
Public propertyStopOnOperationFailureIndicates whether the File Transfer Protocol (FTP) task terminates when the FTP operation fails.
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 a 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 saved as .xml, 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 component is properly configured. (Overrides Task.Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging).)
Top

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