FtpTask Class

 

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

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

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

[GuidAttribute("613C335B-A72A-4962-A221-510FF6EFE9B5")]
public sealed class FtpTask : Task, IDTSFTPTask, IDTSComponentPersist, 
	IDTSBreakpointSite, IDTSSuspend

NameDescription
System_CAPS_pubmethodFtpTask()

Initializes a new instance of the FtpTask class.

NameDescription
System_CAPS_pubpropertyConnection

Gets or sets the connection name of the FTP connection manager used by the task.

System_CAPS_pubpropertyDebugMode

Indicates whether a task should check if breakpoints are enabled.

System_CAPS_pubpropertyExecutionValue

Returns a user-defined object. This property is read-only.(Overrides Task.ExecutionValue.)

System_CAPS_pubpropertyIsLocalPathVariable

Indicates whether the local path is stored in a variable or a FILE connection manager.

System_CAPS_pubpropertyIsRemotePathVariable

Indicates whether the remote path is stored in a variable.

System_CAPS_pubpropertyIsTransferTypeASCII

Indicates whether files transferred to and from the remote FTP server should be transferred in ASCII mode.

System_CAPS_pubpropertyLocalPath

Gets or sets the local path to use. The local path can refer to a FILE connection manager or a variable name.

System_CAPS_pubpropertyOperation

Gets or sets a value from the DTSFTPOp enumeration that indicates the FTP operation to perform.

System_CAPS_pubpropertyOperationName

Gets or sets a unique name for the File Transfer Protocol (FTP) task.

System_CAPS_pubpropertyOverwriteDestination

Specifies whether a file at the destination can be overwritten.

System_CAPS_pubpropertyRemotePath

Gets or sets the remote path to use.

System_CAPS_pubpropertyStopOnOperationFailure

Indicates whether the File Transfer Protocol (FTP) task terminates when the FTP operation fails.

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 a 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 saved as .xml, 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 component is properly configured.(Overrides Task.Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging).)

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: