Differences
This shows you the differences between the selected revisions of the page.
| 2016-01-22 | 2016-01-22 | ||
| library_sessionoptions#timeout (martin) | property anchors (martin) | ||
| Line 24: | Line 24: | ||
| ===== Properties ===== | ===== Properties ===== | ||
| ^ Name ^ Description ^ | ^ Name ^ Description ^ | ||
| - | | 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 | Deprecated. Do not use. Use ''[[library_session_addrawconfiguration|Session.AddRawConfiguration]]'' instead. | | + | | bool ==DefaultConfiguration== | Deprecated. Do not use. Use ''[[library_session_addrawconfiguration|Session.AddRawConfiguration]]'' instead. | |
| - | | 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 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. &beta_feature | | + | | 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. &beta_feature | |
| - | | SecureString ExecutableProcessPassword| See ''ExecutableProcessUserName''. | | + | | SecureString ==ExecutableProcessPassword== | See ''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. | | + | | string ==IniFilePath== | 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''. 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. | |
| | [[library_doc_collections|StringCollection]] Output | Output of WinSCP console session. See also ''[[library_session_outputdatareceived|OutputDataReceived]]'' event. Read-only. | | | [[library_doc_collections|StringCollection]] Output | Output of WinSCP console session. See also ''[[library_session_outputdatareceived|OutputDataReceived]]'' event. Read-only. | | ||
| - | | TimeSpan ReconnectTime | Sets time limit in seconds to try reconnecting broken sessions. Default is 120 seconds. Use ''TimeSpan.MaxValue'' to remove any limit. The property has to be set before calling ''Open''. | | + | | TimeSpan ==ReconnectTime== | Sets time limit in seconds to try reconnecting broken sessions. Default is 120 seconds. Use ''TimeSpan.MaxValue'' to remove any limit. The property has to be set before calling ''Open''. | |
| - | | int ReconnectTimeInMilliseconds | Alternative to ''ReconnectTime''. Particularly useful for COM hosts, that cannot use ''TimeSpan'', such as Visual Basic. | | + | | int ==ReconnectTimeInMilliseconds== | Alternative to ''ReconnectTime''. Particularly useful for COM hosts, that cannot use ''TimeSpan'', such as Visual Basic. | |
| - | | TimeSpan Timeout | Maximal interval between two consecutive outputs from WinSCP console session, before ''TimeoutException'' is thrown. The default is one minute. It's not recommended to change the value. For session/connection timeout, see ''[[library_sessionoptions#timeout|SessionOptions.Timeout]]''. | | + | | TimeSpan ==Timeout== | Maximal interval between two consecutive outputs from WinSCP console session, before ''TimeoutException'' is thrown. The default is one minute. It's not recommended to change the value. For session/connection timeout, see ''[[library_sessionoptions#timeout|SessionOptions.Timeout]]''. | |
| ===== Methods ===== | ===== Methods ===== | ||