Differences
This shows you the differences between the selected revisions of the page.
| 2018-08-31 | 2018-08-31 | ||
| marking deprecated methods (martin) | consistency (martin) | ||
| Line 27: | Line 27: | ||
| | string ==DebugLogLevel== | Logging level of debug log to. The default value is ''0''. The maximal logging level is ''2''. | | | string ==DebugLogLevel== | Logging level of debug log to. The default value is ''0''. The maximal logging level is ''2''. | | ||
| | string ==DebugLogPath== | Path to store assembly debug log to. Default ''null'' means, no debug log file is created. See also ''[[#sessionlogpath|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|SessionLogPath]]''. The property has to be set before calling ''Open''. | | ||
| - | | bool ==DefaultConfiguration== | Deprecated. Do not use. Use ''[[library_session_addrawconfiguration|Session.AddRawConfiguration]]'' instead. | | + | | <del>bool ==DefaultConfiguration==</del> | Deprecated. Do not use. Use ''[[library_session_addrawconfiguration|Session.AddRawConfiguration]]'' instead. | |
| - | | bool ==DisableVersionCheck== | Deprecated. 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''. | | + | | <del>bool ==DisableVersionCheck==</del> | Deprecated. 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 ==ExecutableProcessUserName== | If the .NET process is running in an impersonated environment, you need to provide credentials of the impersonated account, so that the ''winscp.exe'' process can be started with the same privileges. | | | string ==ExecutableProcessUserName== | If the .NET process is running in an impersonated environment, you need to provide credentials of the impersonated account, so that the ''winscp.exe'' process can be started with the same privileges. | | ||
| | SecureString ==ExecutableProcessPassword== | See ''[[#executableprocessusername|ExecutableProcessUserName]]''. | | | SecureString ==ExecutableProcessPassword== | See ''[[#executableprocessusername|ExecutableProcessUserName]]''. | | ||
| | 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== | Deprecated. Do not use. Use ''[[library_session_addrawconfiguration|Session.AddRawConfiguration]]'' instead. | | + | | <del>string ==IniFilePath==</del> | Deprecated. Do not use. Use ''[[library_session_addrawconfiguration|Session.AddRawConfiguration]]'' instead. | |
| | string ==SessionLogPath== | Path to store [[logging|session log file]] to. Default ''null'' means, no session log file is created. See also ''[[#debuglogpath|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|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. | | ||
| Line 48: | Line 48: | ||
| | [[library_session_createdirectory|CreateDirectory]] | Creates remote directory. | | | [[library_session_createdirectory|CreateDirectory]] | Creates remote directory. | | ||
| | [[library_session_close|Close]] | Closes session. | | | [[library_session_close|Close]] | Closes session. | | ||
| - | | <del>[[library_session_combinepaths|CombinePaths]]</del> | Combines strings into a remote path (deprecated). | | + | | <del>[[library_session_combinepaths|CombinePaths]]</del> | Deprecated. Combines strings into a remote path. | |
| | [[library_session_dispose|Dispose]] | Closes session and disposes object. | | | [[library_session_dispose|Dispose]] | Closes session and disposes object. | | ||
| | [[library_session_duplicatefile|DuplicateFile]] | Duplicates remote file to another remote directory. | | | [[library_session_duplicatefile|DuplicateFile]] | Duplicates remote file to another remote directory. | | ||
| - | | <del>[[library_session_escapefilemask|EscapeFileMask]]</del> | Converts special characters in file path to make it unambiguous file mask/wildcard (deprecated). | | + | | <del>[[library_session_escapefilemask|EscapeFileMask]]</del> | Deprecated. Converts special characters in file path to make it unambiguous file mask/wildcard. | |
| | [[library_session_enumerateremotefiles|EnumerateRemoteFiles]] | Recursively enumerates remote files. | | | [[library_session_enumerateremotefiles|EnumerateRemoteFiles]] | Recursively enumerates remote files. | | ||
| | [[library_session_executecommand|ExecuteCommand]] | Executes command on the remote server. | | | [[library_session_executecommand|ExecuteCommand]] | Executes command on the remote server. | | ||
| Line 64: | Line 64: | ||
| | [[library_session_scanfingerprint|ScanFingerprint]] | Scans a fingerprint of SSH server public key or FTPS/WebDAVS TLS certificate. | | | [[library_session_scanfingerprint|ScanFingerprint]] | Scans a fingerprint of SSH server public key or FTPS/WebDAVS TLS certificate. | | ||
| | [[library_session_synchronizedirectories|SynchronizeDirectories]] | Synchronizes local directory with remote directory. | | | [[library_session_synchronizedirectories|SynchronizeDirectories]] | Synchronizes local directory with remote directory. | | ||
| - | | <del>[[library_session_translatelocalpathtoremote|TranslateLocalPathToRemote]]</del> | Generates a remote path equivalent of a local path, given root paths (deprecated). | | + | | <del>[[library_session_translatelocalpathtoremote|TranslateLocalPathToRemote]]</del> | Deprecated. Generates a remote path equivalent of a local path, given root paths. | |
| - | | <del>[[library_session_translateremotepathtolocal|TranslateRemotePathToLocal]]</del> | Generates a local path equivalent of a remote path, given root paths (deprecated). | | + | | <del>[[library_session_translateremotepathtolocal|TranslateRemotePathToLocal]]</del> | Deprecated. Generates a local path equivalent of a remote path, given root paths. | |