SecureBlackbox Lite 2020 Qt Edition

Questions / Feedback?

SFTPClient Configuration

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

SFTPClient Configuration Settings

AdjustFileTimes:   Whether file times should be adjusted after upload/download.

If this property value is True, file times (creation, access and last modification times) will be adjusted after upload/download operation.

ASCIIMode:   Whether ASCII transfer mode is used.

When this property is True, ASCII (text) transfer mode is used, otherwise the transfer is performed in binary mode.

AvailableSpace:   Returns details of server disk space availability. This protocol extension must be supported by the server for this request to work.

This config property returns the details of the server disk space. The information is provided in the form of semicolon-separated entries: BytesOnDevice, UnusedBytesOnDevice, BytesAvailableToUser, UnusedBytesAvailableToUser, BytesPerAllocationUnit. You can use this property without parameters, or provide a specific mounting point in brackets: AvailableSpace(./path).

CaseConversion:   Whether case conversion must be applied to file names as they are downloaded.

You can choose to: convert file names to upper case, convert file names to lower case, or to keep them as they are.

CaseSensitive:   Specifies if file paths are case-sensitive.

Set this property to True if all file names, paths and file masks should be case-sensitive.

CopyMode:   Defines what to do with each successfully copied file.

You could choose to: simply copy the file, delete each file's origin right after that file has been copied, or delete all original files only after all files have been copied.

DefOutboundBlockSize:   The default outbound block size.

Use this property to configure the outbound data block size.

DisablePacketFragmentation:   Enables or disables SSH packet fragmentation.

Use this property to enable or disable SSH packet fragmentation. This is one of the settings that is worth a look if encountering unexplained transfer issues.

ErrorOrigin:   Specifies whether the error is local or remote.

Use this property to check where the error took place.

ErrorSeverity:   Specifies whether the error is fatal.

Use this property to check whether the error is fatal or not.

FileHash:   Returns the hash of the specified file. This protocol extension must be supported by the server for this request to work.

Use this property to request the hash of a remote file. Pass the file name in brackets: FileHash(./path/file.ext). You can adjust the hash algorithm using the HashAlgorithm configuration setting.

HashAlgorithm:   The hash algorithm to use for the protocol operations.

Specifies the hash algorithm to use for file protocol operations, such as FileHash.

HomeDir:   Returns a user's home directory. This protocol extension must be supported by the server for this request to work.

Use this property to request a specific user's home directory on the server. Provide the username in brackets: HomeDir(user2).

IncomingSpeedLimit:   Specifies incoming speed limit.

Use this property to limit the maximum number of bytes per second that client may receive. The value of 0 (zero) means "no limitation".

KeepAlivePeriod:   The inactivity period after which a keep-alive signal will be sent.

Use this property to specify tunnel inactivity period (in milliseconds) after which a keep-alive signal will be sent. The default value is 0 (no keep-alive signals).

LocalCharset:   Charset used on the client machine.

This property specifies the charset used on the local client computer.

LocalNewLineConvention:   A character string for the end of line (EOL) indication on the local machine.

This property contains a character string for the end of line (EOL) indication on the local machine.

Mode:   The file open mode to use.

This property allows to provide a custom file upload mode.

NewLineConvention:   A character string for the end of line (EOL) indication on the server.

This property contains a character string for the end of line (EOL) indication used by the server. Usually its value is one of: 0x0d, 0x0d0x0a, 0x0a0x0d, or 0x0a, but it can differ for some servers.

OutgoingSpeedLimit:   Specifies incoming speed limit.

Use this property to limit the maximum number of bytes per second that client may send. The value of 0 (zero) means "no limitation".

PreserveExistingFileTimes:   Whether original file times should be restored upon transfer.

If the destination file exists and PreserveExistingFileTimes option is enabled, the class will remember the file's times before transfer, and restore them after the file has been transferred. The default value is False.

Recursive:   Whether subdirectories should also be scanned for matching files.

Set this property to True to indicate that subdirectories should also be scanned for matching files

RedirectStdErr:   Whether to redirect output to StdErr.

If this property is True, all output will be redirected to StdErr.

RemoteCharset:   Charset used on the server.

This property specifies the charset used on the server.

SFTPBufferSize:   The size of internal buffer used for data transfer.

Use this property to control the size of the internal buffers used for data transfer.

SFTPServerExecutableLocations:   Location of the SFTP server executable.

Specifies the location of the SFTP server executable.

StatVFS:   Returns VFS details. This protocol extension must be supported by the server for this request to work.

This config property returns the VFS details of the server file system. The information is provided in the form of semicolon-separated entries. You can use this property without parameters, or provide a specific mounting point in brackets: StatVFS(./).

StdErrData:   The buffer for writing StdErr data.

This property represents a buffer where StdErr data is written by the class.

TempFolder:   Returns the temporary directory offered by the server. This protocol extension must be supported by the server for this request to work.

Use this property to request a path to the temporary directory maintained by the server.

TempPath:   Location where the temporary files are stored.

This setting specifies an absolute path to the location on disk where temporary files are stored.

TreatZeroSizeAsUndefined:   Whether zero size returned by STAT should be considered as undefined.

This property specifies if the size of zero returned by the STAT command for a particular file should be considered as undefined. It makes sense to set this property to True, because some operating systems (e.g. Unix-based) return zero size for the files of certain type. For instance, most of the files contained in the /proc directory are reported as 0-sized, while actually not being empty.

UseTruncateFlagOnUpload:   whether to use the 'truncate' flag on file upload.

If this property is True, the existing files are opened truncated on upload, otherwise new files are created. The default value is True.

UseUTF8OnV3:   Whether to apply UTF-8 conversion for SFTP protocol versions 3 and lower.

If this property is True, UTF-8 encoding will be applied to file names for SFTP protocol versions 3 and lower.

Copyright (c) 2022 /n software inc. - All rights reserved.
SecureBlackbox Lite 2020 Qt Edition - Version 20.0 [Build 8166]