Differences

This shows you the differences between the selected revisions of the page.

library_transferoperationresult 2012-03-26 library_transferoperationresult 2022-09-08 (current)
Line 1: Line 1:
====== TransferOperationResult Class ====== ====== TransferOperationResult Class ======
-Represents results of transfer operation.·+Represents results of transfer operation.
-&beta_feature+~~AD~~
===== Syntax ===== ===== Syntax =====
Line 20: Line 20:
| [[library_doc_collections|SessionRemoteExceptionCollection]] Failures | Collection of all errors that occured during batch operation. See ''[[library_sessionremoteexception|SessionRemoteException]]''. See also [[library_session#results|Capturing results of operations]]. Read-only. (Inherited from ''[[library_operationresultbase|OperationResultBase]]''.) | | [[library_doc_collections|SessionRemoteExceptionCollection]] Failures | Collection of all errors that occured during batch operation. See ''[[library_sessionremoteexception|SessionRemoteException]]''. See also [[library_session#results|Capturing results of operations]]. Read-only. (Inherited from ''[[library_operationresultbase|OperationResultBase]]''.) |
| bool IsSuccess | Is ''true'', if ''Failures'' is empty collection. Read-only. (Inherited from ''[[library_operationresultbase|OperationResultBase]]''.) | | bool IsSuccess | Is ''true'', if ''Failures'' is empty collection. Read-only. (Inherited from ''[[library_operationresultbase|OperationResultBase]]''.) |
-| [[library_doc_collections|TransferEventArgsCollection]] Transfers | Collection of transfers. See ''[[library_transfereventargs|TransferEventArgs]]''. Read-only. |+| [[library_doc_collections|TransferEventArgsCollection]] ==Transfers== | Collection of transfers. See ''[[library_transfereventargs|TransferEventArgs]]''. Read-only. |
===== Methods ===== ===== Methods =====
^ Name ^ Description ^ ^ Name ^ Description ^
-| Check | Noop, if ''IsSuccess'' is ''true''. Throws the first error in ''Failures'', if ''IsSuccess'' is ''false''. |+| ==Check== | Noop, if ''IsSuccess'' is ''true''. Throws the first error in ''Failures'', if ''IsSuccess'' is ''false''. (Inherited from ''[[library_operationresultbase|OperationResultBase]]''.) |
===== Remarks ===== ===== Remarks =====
-Instance of the class is returned by ''[[library_session_getfiles|Session.GetFiles]]'' and ''[[library_session_putfiles|Session.PutFiles]]''.+This class can only be instantiated by the WinSCP assembly. To get an instance of the class, call ''[[library_session_getfiles|Session.GetFiles]]'' and ''[[library_session_putfiles|Session.PutFiles]]''. 
 + 
 +===== Example ===== 
 +See [[library#example|overall example for WinSCP .NET assembly]]. 
 + 
 +==== Real-Life Examples ==== 
 + 
 +  * [[library_example_recursive_search_text|*]]; 
 +  * [[library_example_recursive_download_custom_error_handling|*]]; 
 +  * [[library_example_find_duplicate_files|*]]; 
 +  * [[faq_script_modified_files|*]]. 

Last modified: by martin