Differences
This shows you the differences between the selected revisions of the page.
| 2014-07-23 | 2014-07-23 | ||
| no summary (178.77.154.52) (hidden) | Restored revision 1405340279. Undoing revision 1406128449. (martin) (hidden) | ||
| Line 1: | Line 1: | ||
| - | محمد الرمثاوي | + | ====== TransferOptions Class ====== |
| + | Defines options for file transfers. | ||
| + | |||
| + | ~~AD~~ | ||
| + | |||
| + | ===== Syntax ===== | ||
| + | Namespace: ''WinSCP'' | ||
| + | |||
| + | <code csharp *> | ||
| + | public sealed class TransferOptions | ||
| + | </code> | ||
| + | |||
| + | <code vbnet *> | ||
| + | Public NotInheritable Class TransferOptions | ||
| + | </code> | ||
| + | |||
| + | ===== Constructors ===== | ||
| + | ^ Name ^ Description ^ | ||
| + | | TransferOptions() | Default constructor. | | ||
| + | |||
| + | ===== Properties ===== | ||
| + | ^ Name ^ Description ^ | ||
| + | | string FileMask | [[ui_transfer_custom#other_options|File mask]]. | | ||
| + | | [[library_filepermissions|FilePermissions]] FilePermissions | Permissions to applied to a remote file (used for uploads only). Use default ''null'' to keep default permissions. | | ||
| + | | bool PreserveTimestamp | Preserve timestamp (set last write time of destination file to that of source file). Defaults to ''true''. \\ When used with ''[[library_session_synchronizedirectories|Session.SynchronizeDirectories]]'', timestamp is always preserved, disregarding property value, unless ''criteria'' parameter is ''SynchronizationCriteria.None'' or ''SynchronizationCriteria.Size''. | | ||
| + | | TransferMode TransferMode | [[transfer_mode|Transfer mode]]. Possible values are ''TransferMode.Binary'' (default), ''TransferMode.Ascii'' and ''TransferMode.Automatic'' (based on file extension). | | ||
| + | | [[library_transferresumesupport|TransferResumeSupport]] ResumeSupport | Configures [[resume#automatic|automatic resume/transfer to temporary filename]]. Read-only (set properties of returned ''[[library_transferresumesupport|TransferResumeSupport]]'' instance). | | ||
| + | | int SpeedLimit | Limit transfer speed (in KB/s). &beta_feature | | ||
| + | |||
| + | ===== Remarks ===== | ||
| + | Use instance of the class with ''[[library_session_getfiles|Session.GetFiles]]'', ''[[library_session_putfiles|Session.PutFiles]]'' or ''[[library_session_synchronizedirectories|Session.SynchronizeDirectories]]''. | ||
| + | |||
| + | ===== Example ===== | ||
| + | See [[library#example|overall example for WinSCP .NET assembly]]. | ||
| + | |||