Contents » .NET Assembly » Session Class »

Session.PutFiles Method

Table of Contents

Syntax
- Parameters
- Return Value
Exceptions
Remarks
Example

Uploads one or more files from local directory to remote directory.

Syntax

C#	public TransferOperationResult PutFiles( string localPath, string remotePath, bool remove = false, TransferOptions options = null )

VB.NET

Public Function PutFiles( _
    ByVal localPath As String, _
    ByVal remotePath As String, _
    ByVal Optional remove As Boolean = False, _
    ByVal Optional options As TransferOptions = Null _
) As TransferOperationResult

Parameters

Name	Description
string localPath	Full path to local file or directory to upload. Filename in the path can be replaced with Windows wildcard1) to select multiple files. When file name is omitted (path ends with backslash), all files and subdirectories in the local directory are uploaded.
string remotePath	Full path to upload the file to. When uploading multiple files, the filename in the path should be replaced with operation mask or omitted (path ends with slash).
bool remove	When set to `true`, deletes source local file(s) after transfer. Defaults to `false`.
TransferOptions options	Transfer options. Defaults to `null`, what is equivalent to `new TransferOptions()`.

Return Value

TransferOperationResult. See also Capturing results of operations.

Advertisements:

Exceptions

Exception	Condition
InvalidOperationException	Session is not opened.
ArgumentException ArgumentOutOfRangeException	Invalid combination of values of `TransferOptions` properties.
SessionLocalException	Error communicating with `winscp.com`. See the exception documentation for details.
TimeoutException	Timeout waiting for `winscp.com` to respond.

Remarks

Event Session.FileTransferred is raised for every uploaded file.

Example

See overall example for WinSCP .NET assembly.

1) Windows wildcard supports * and ? only. It does not support all the features of file masks.

WinSCP Free SFTP, SCP and FTP client for Windows

Session.PutFiles Method

Syntax

Parameters

Return Value

Exceptions

Remarks

Example

Search Documentation

This page

Donate

Recommend

Associations