Differences
This shows you the differences between the selected revisions of the page.
| 2014-12-19 | 2015-02-18 | ||
| library_session_calculatefilechecksum (martin) | releasing 5.7 stable, removing &beta tags (or replacing with &recent) (martin) | ||
| Line 29: | Line 29: | ||
| | 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 you will 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 you will 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''. &beta_feature | | + | | 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 | 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 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 unlimited (//in the stable release//) or 120 seconds (//in the latest beta release//)&beta. 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. &beta_feature | | + | | 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|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|SessionOptions.Timeout]]''. | | ||
| Line 77: | Line 77: | ||
| ==== [[results]] Capturing Results of Operations ==== | ==== [[results]] Capturing Results of Operations ==== | ||
| - | There are two classes of operations, hence two classes of methods; atomic operations, such as ''[[library_session_open|Open]]'', ''[[library_session_open|ListDirectory]]'', ''[[library_session_executecommand|ExecuteCommand]]'' (prior to 5.6.2 beta), &beta etc; and batch operations, such as ''[[library_session_getfiles|GetFiles]]'', ''[[library_session_putfiles|PutFiles]]'', ''[[library_session_synchronizedirectories|SynchronizeDirectories]]'', etc. | + | There are two classes of operations, hence two classes of methods; atomic operations, such as ''[[library_session_open|Open]]'', ''[[library_session_open|ListDirectory]]'', etc; and batch operations, such as ''[[library_session_getfiles|GetFiles]]'', ''[[library_session_putfiles|PutFiles]]'', ''[[library_session_synchronizedirectories|SynchronizeDirectories]]'', etc. |
| Methods from both classes throw ''[[library_sessionlocalexception|SessionLocalException]]'' on error in communication with WinSCP console session. | Methods from both classes throw ''[[library_sessionlocalexception|SessionLocalException]]'' on error in communication with WinSCP console session. | ||