Back to product page

LocalPath property


Holds the name of the local path used for transferring.

Type

A String value. Specifies the full path on the local computer.

Syntax

  • Basic
object.LocalPath [= value]
The LocalPath(object,value) syntax has these parts:
objectAn expression evaluating to an object of type wodSFTP.
valueA String value.

Remarks

This property specifies the filename (or directory name) on the local computer which will be used in a call to any of the methods that require it. All the methods that support LocalPath as an argument will also use this value as a default.

For example, the GetFile method has two optional arguments: LocalPath and RemoteFile. If you don't set the LocalPath argument, you should specify it in this property prior to calling the method. If you specify the LocalPath argument, wodSFTP will overwrite the LocalPath property with the value supplied in the argument.

Platforms

Windows