Differences
This shows you the differences between the selected revisions of the page.
| 2015-10-06 | 2015-12-21 | ||
| Grammatical error (89.204.223.13) | 5.8 Change: Deprecating Session.DefaultConfiguration in favor of Session.AddRawConfiguration. (martin) | ||
| Line 26: | Line 26: | ||
| | string AdditionalExecutableArguments | Additional command-line arguments to be passed to ''[[executables#winscp.com|winscp.com]]''. In general, this should be left with default ''null''. | | | string AdditionalExecutableArguments | Additional command-line arguments to be passed to ''[[executables#winscp.com|winscp.com]]''. In general, this should be left with default ''null''. | | ||
| | string DebugLogPath | Path to store assembly debug log to. Default ''null'' means, no debug log file is created. See also ''SessionLogPath''. The property has to be set before calling ''Open''. | | | string DebugLogPath | Path to store assembly debug log to. Default ''null'' means, no debug log file is created. See also ''SessionLogPath''. The property has to be set before calling ''Open''. | | ||
| - | | bool DefaultConfiguration | Should WinSCP be forced with the default [[config|configuration]]? ''true'' by default. Useful to isolate the console session run from any configuration stored on this machine. Set to ''false'' only in an exceptional scenarios. The property has to be set before calling ''Open''. | | + | | bool DefaultConfiguration | Deprecated. Do not use. | |
| | bool DisableVersionCheck | Disables test that WinSCP [[executables|executables]] have the same product version as this assembly.((Note, even if you set this property, you need to use the assembly with compatible WinSCP executable only. Otherwise the behavior is unpredictable. In general, it is not recommended to use this. In neither case will you be able to use the assembly with WinSCP 5.0.4 or older.)) The property has to be set before calling ''Open''. | | | bool DisableVersionCheck | Disables test that WinSCP [[executables|executables]] have the same product version as this assembly.((Note, even if you set this property, you need to use the assembly with compatible WinSCP executable only. Otherwise the behavior is unpredictable. In general, it is not recommended to use this. In neither case will you be able to use the assembly with WinSCP 5.0.4 or older.)) The property has to be set before calling ''Open''. | | ||
| | string ExecutablePath | Path to ''[[executables#winscp.exe|winscp.exe]]''. The default is ''null'', meaning that ''winscp.exe'' is looked for in the same directory as this assembly or in an installation folder. The property has to be set before calling ''Open''. | | | string ExecutablePath | Path to ''[[executables#winscp.exe|winscp.exe]]''. The default is ''null'', meaning that ''winscp.exe'' is looked for in the same directory as this assembly or in an installation folder. The property has to be set before calling ''Open''. | | ||
| | string HomePath | Path to a remote home directory. The property can be read only after calling ''Open''. | | | string HomePath | Path to a remote home directory. The property can be read only after calling ''Open''. | | ||
| - | | string IniFilePath | Path to an INI file. Used only when ''DefaultConfiguration'' is ''false''. When ''null'', default WinSCP configuration storage is used, meaning INI file, if any is present in WinSCP startup directory, or Windows Registry otherwise. The property has to be set before calling ''Open''. | | + | | string IniFilePath | Deprecated. Do not use. | |
| | string SessionLogPath | Path to store [[logging|session log file]] to. Default ''null'' means, no session log file is created. See also ''DebugLogPath''. The property has to be set before calling ''Open''. | | | string SessionLogPath | Path to store [[logging|session log file]] to. Default ''null'' means, no session log file is created. See also ''DebugLogPath''. The property has to be set before calling ''Open''. | | ||
| | bool Opened | Is session opened yet? ''true'', when ''Open'' was successfully called already. Read-only. | | | bool Opened | Is session opened yet? ''true'', when ''Open'' was successfully called already. Read-only. | | ||