FtpTask.LocalPath Property

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

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

Syntax

'Declaration
Public Property LocalPath As String
    Get
    Set
'Usage
Dim instance As FtpTask
Dim value As String

value = instance.LocalPath

instance.LocalPath = value

public string LocalPath { get; set; }

public:
virtual property String^ LocalPath {
    String^ get () sealed;
    void set (String^ value) sealed;
}

abstract LocalPath : string with get, set
override LocalPath : string with get, set

final function get LocalPath () : String
final function set LocalPath (value : String)

Property Value

Type: System.String
A String that contains the local path.

Implements

IDTSFTPTask.LocalPath

Examples

The following code example creates an FtpTask, then shows the default values it contains after creation. Some fields are empty, and must be explicitly set before the task is executed in the package.

using System;
using System.Collections.Generic;
using System.Text;
using Microsoft.SqlServer.Dts.Runtime;
using Microsoft.SqlServer.Dts.Tasks.FtpTask;

namespace FTPTask
{
    class Program
    {
        static void Main(string[] args)
        {
            Package pkg = new Package();
            Executable exec1 = pkg.Executables.Add("STOCK:FTPTask");
            TaskHost th = exec1 as TaskHost;

            // List the default values of the FTP task
            // using the Properties collection of the TaskHost.
            Console.WriteLine("Connection           {0}", th.Properties["Connection"].GetValue(th));
            Console.WriteLine("DebugMode            {0}", th.Properties["DebugMode"].GetValue(th));
            Console.WriteLine("ExecutionValue       {0}", th.Properties["ExecutionValue"].GetValue(th));
            Console.WriteLine("IsLocalPathVariable  {0}", th.Properties["IsLocalPathVariable"].GetValue(th));
            Console.WriteLine("IsRemotePathVariable {0}", th.Properties["IsRemotePathVariable"].GetValue(th));
            Console.WriteLine("IsTransferTypeASCII  {0}", th.Properties["IsTransferTypeASCII"].GetValue(th));
            Console.WriteLine("LocalPath            {0}", th.Properties["LocalPath"].GetValue(th));
            Console.WriteLine("Operation            {0}", th.Properties["Operation"].GetValue(th));
            Console.WriteLine("OperationName        {0}", th.Properties["OperationName"].GetValue(th));
            Console.WriteLine("OverwriteDestination {0}", th.Properties["OverwriteDestination"].GetValue(th));
            Console.WriteLine("RemotePath           {0}", th.Properties["RemotePath"].GetValue(th));
            Console.WriteLine("StopOnOperationFailure  {0}", th.Properties["StopOnOperationFailure"].GetValue(th));
            Console.WriteLine("SuspendRequired      {0}", th.Properties["SuspendRequired"].GetValue(th));

            Console.WriteLine("--------------------------");
            // Show how to set a property using the TaskHost Properties.
            th.Properties["Operation"].SetValue(th, DTSFTPOp.Receive);
            Console.WriteLine("New value of Operation:  {0}", th.Properties["Operation"].GetValue(th));
        }
    }
}

Imports System
Imports System.Collections.Generic
Imports System.Text
Imports Microsoft.SqlServer.Dts.Runtime
Imports Microsoft.SqlServer.Dts.Tasks.FtpTask
 
Namespace FTPTask
    Class Program
        Shared  Sub Main(ByVal args() As String)
            Dim pkg As Package =  New Package() 
            Dim exec1 As Executable =  pkg.Executables.Add("STOCK:FTPTask") 
            Dim th As TaskHost =  exec1 as TaskHost 

            ' List the default values of the FTP task
            ' using the Properties collection of the TaskHost.
            Console.WriteLine("Connection           {0}", th.Properties("Connection").GetValue(th))
            Console.WriteLine("DebugMode            {0}", th.Properties("DebugMode").GetValue(th))
            Console.WriteLine("ExecutionValue       {0}", th.Properties("ExecutionValue").GetValue(th))
            Console.WriteLine("IsLocalPathVariable  {0}", th.Properties("IsLocalPathVariable").GetValue(th))
            Console.WriteLine("IsRemotePathVariable {0}", th.Properties("IsRemotePathVariable").GetValue(th))
            Console.WriteLine("IsTransferTypeASCII  {0}", th.Properties("IsTransferTypeASCII").GetValue(th))
            Console.WriteLine("LocalPath            {0}", th.Properties("LocalPath").GetValue(th))
            Console.WriteLine("Operation            {0}", th.Properties("Operation").GetValue(th))
            Console.WriteLine("OperationName        {0}", th.Properties("OperationName").GetValue(th))
            Console.WriteLine("OverwriteDestination {0}", th.Properties("OverwriteDestination").GetValue(th))
            Console.WriteLine("RemotePath           {0}", th.Properties("RemotePath").GetValue(th))
            Console.WriteLine("StopOnOperationFailure  {0}", th.Properties("StopOnOperationFailure").GetValue(th))
            Console.WriteLine("SuspendRequired      {0}", th.Properties("SuspendRequired").GetValue(th))
 
            Console.WriteLine("--------------------------")
            ' Show how to set a property using the TaskHost Properties.
            th.Properties("Operation").SetValue(th, DTSFTPOp.Receive)
            Console.WriteLine("New value of Operation:  {0}", th.Properties("Operation").GetValue(th))
        End Sub
    End Class
End Namespace

Sample Output:

Connection

DebugMode False

ExecutionValue 0

IsLocalPathVariable False

IsRemotePathVariable False

IsTransferTypeASCII False

LocalPath

Operation 0

OperationName

OverwriteDestination False

RemotePath

StopOnOperationFailure True

SuspendRequired False

--------------------------

New value of Operation: 1

See Also

Reference

FtpTask Class

Microsoft.SqlServer.Dts.Tasks.FtpTask Namespace