This is an old revision of the document!
Raw Configuration
You can use raw configuration to setup rare advanced global settings.
In scripting and with command-line operations, use /rawconfig parameter (when the settings cannot be configured using dedicated command-line parameter or scripting command).
In .NET assembly, use Session.AddRawConfiguration method (when the settings cannot be configured using any dedicated property of Session class).
Advertisement
Common Advanced Settings
| Name | Description | Values |
|---|---|---|
Interface\ExternalIpAddress |
External IP address | |
Interface\SessionReopenAuto |
Delay of automatic reconnect of session that breaks during transfer. | In milliseconds. 0 = disable automatic reconnect |
Interface\KeepUpToDateChangeDelay |
Upload delay after change is detected while Keeping remote directory up to date | In milliseconds. |
Interface\CopyParam\NewerOnly |
New and updated files only | 0 = Off, 1 = On |
Interface\CopyParam\FileNameCase |
File name case modification | 0 = No change, 1 = Upper case, 2 = Lower case, 4 = Lower case 8.3 |
Interface\CopyParam\ReplaceInvalidChars |
Replace ‘\:*?’ | 0 = Do not replace, 1 = replace with %XX, where the XX is a hexadecimal code of the invalid character, any other value = replace with the character specified by the option value (e.g. 95 for an underscore) |
Interface\CopyParam\IncludeFileMask |
File mask | To be used with command-line operations only. In scripting use the -filemask switch; in .NET assembly, use the TransferOptions.FileMask. |
Interface\CopyParam\IgnorePermErrors |
Ignore permission errors | 0 = Off, 1 = On |
Interface\CopyParam\PreserveTimeDirs |
Preserve directory timestamps | 0 = Off, 1 = On |
Interface\LocalIconsByExt |
Turn off loading icons from local files | 0 - Load icons from local files, 1 - Resolve icons for local files by file extension only |
Interface\HonorDrivePolicy |
Follow Windows explorer configuration for hiding drives | 0 - Show all drives, 1 - Hide hidden drives |
Interface\LocaleSafe |
Language | Decimal LCID of the language/locale. E.g. 1033 for English (United States) |
Interface\BeepSound |
A path to a sound file or system sound alias for the Beep when work finishes function. | Defaults to system sound alias SystemDefault. |
Interface\MinimizeToTray |
Minimize main window to taskbar status area. | 0 = Off, 1 = On |
Interface\TryFtpWhenSshFails |
When SFTP connection is rejected, knock FTP port | 0 = Off, 1 = On |
Interface\SynchronizeOptions |
Options for Keep Remote Directory up to Date | Bitmask. 1 = Update subdirectories, 2 = Synchronize on start, 4 = Ask user whether to Synchronize on start, 8 = Continue on error The 4 and 8 has an effect with /keepuptodate command-line operation only. |
Interface\SynchronizeParams |
Options for Synchronization and Keep Remote Directory up to Date | Bitmask. 1 = Delete files (with /keepuptodate and /synchronize command-line operations only, in scripting use the -delete switch, in .NET assembly, use the removeFiles argument of the Session.SynchronizeDirectories), 4 = Existing files only, 64 = Preview changes (with /synchronize command-line operation only, in scripting use the -preview switch, not available in .NET assembly), 256 = Synchronize timestamps mode, 512 = Turn off Modification time comparison criteria (with /synchronize command-line operation only, in scripting use the -criteria=none or =size switch, in .NET assembly, set the criteria argument of the Session.SynchronizeDirectories to SynchronizationCriteria.None or .Size), 1024 = File size comparison criteria (with /synchronize command-line operation only, in scripting use the -criteria=size or =either switch, in .NET assembly, set the criteria argument of the Session.SynchronizeDirectories to SynchronizationCriteria.Size or .Either), 4096 = Mirror mode (with /synchronize command-line operations only, in scripting use the -mirror switch, in .NET assembly, use the mirror argument of the Session.SynchronizeDirectories) |
Interface\MaxWatchDirectories |
Keep Remote Directory up to Date directory count warning limit | |
Logging\LogFileAppend |
Append session log file | 0 = Off, 1 = On |
Logging\LogSensitive |
Log passwords and other sensitive information | 0 = Off, 1 = On In the scripting, use a command-line switch /loglevel=*. |
Logging\LogMaxSize |
Rotate log files after reaching | In bytes. |
Logging\LogMaxCount |
Delete old logs files, keep … files |
Advertisement
Other Settings
To find correct syntax for settings not listed above, configure the setting in the GUI, save configuration to an INI file and use the same syntax as you find an INI file.
The settings is identified using syntax section\name, where the section is a path to configuration section from [Configuration] section in an INI file.1 E.g. to configure a setting ExternalIpAddress in section [Configuration\Interface], use Interface\ExternalIpAddress.
Example
For example to configure an External IP address, in scripting:
winscp.com /rawconfig Interface\ExternalIpAddress=198.51.100.10 /script=...
or in .NET assembly (using PowerShell):
$session.AddRawConfiguration("Interface\ExternalIpAddress", "198.51.100.10")
- Or
HKEY_CURRENT_USER\Software\Martin Prikryl\WinSCP 2\Configurationkey in a registryBack