Differences
This shows you the differences between the selected revisions of the page.
| library_session_getfile 2021-02-26 | library_session_getfile 2022-10-21 (current) | ||
| Line 1: | Line 1: | ||
| ====== Session.GetFile Method ====== | ====== Session.GetFile Method ====== | ||
| - | Provides [[https://docs.microsoft.com/en-us/dotnet/api/system.io.stream|''System.IO.Stream'' interface]] to a remote file contents. | + | Provides [[https://learn.microsoft.com/en-us/dotnet/api/system.io.stream|''System.IO.Stream'' interface]] to a remote file contents. |
| - | + | ||
| - | &beta_feature | + | |
| //For an efficient download to a physical local file, use [[library_session_getfiletodirectory|''Session.GetFileToDirectory'']] and similar methods instead.// | //For an efficient download to a physical local file, use [[library_session_getfiletodirectory|''Session.GetFileToDirectory'']] and similar methods instead.// | ||
| Line 26: | Line 24: | ||
| | [[library_transferoptions|TransferOptions]] options | Transfer options. Defaults to ''null'', what is an equivalent to ''new TransferOptions()''. | | | [[library_transferoptions|TransferOptions]] options | Transfer options. Defaults to ''null'', what is an equivalent to ''new TransferOptions()''. | | ||
| - | ==== Return Value ==== | + | ==== [[return_value]] Return Value ==== |
| - | ''[[https://docs.microsoft.com/en-us/dotnet/api/system.io.stream|System.IO.Stream]]'' implementation that can be used to read the remote file contents. It implements the ''[[https://docs.microsoft.com/en-us/dotnet/api/system.io.stream.read|Read]]'' and ''[[https://docs.microsoft.com/en-us/dotnet/api/system.io.stream.dispose|Dispose]]'' methods only, and other methods derived from these two, like ''[[https://docs.microsoft.com/en-us/dotnet/api/system.io.stream.close|Close]]'' and ''[[https://docs.microsoft.com/en-us/dotnet/api/system.io.stream.copyto|CopyTo]]''. Seeking and cancelling the transfer is not supported. Calling the ''Dispose'' (or the ''Close'') will finish downloading the file. | + | ''[[https://learn.microsoft.com/en-us/dotnet/api/system.io.stream|System.IO.Stream]]'' implementation that can be used to read the remote file contents. It implements the ''[[https://learn.microsoft.com/en-us/dotnet/api/system.io.stream.read|Read]]'' and ''[[https://learn.microsoft.com/en-us/dotnet/api/system.io.stream.dispose|Dispose]]'' methods only, and other methods derived from these two, like ''[[https://learn.microsoft.com/en-us/dotnet/api/system.io.stream.close|Close]]'' and ''[[https://learn.microsoft.com/en-us/dotnet/api/system.io.stream.copyto|CopyTo]]''. Seeking and cancelling the transfer is not supported. Calling the ''Dispose'' (or the ''Close'') will finish downloading the file. |
| - | ===== Remarks ===== | + | ===== [[remarks]] Remarks ===== |
| Event ''[[library_session_filetransferred|Session.FileTransferred]]'' is raised for the download. Also raises [[library_session_filetransferprogress|''Session.FileTransferProgress'']] throughout the transfer. | Event ''[[library_session_filetransferred|Session.FileTransferred]]'' is raised for the download. Also raises [[library_session_filetransferprogress|''Session.FileTransferProgress'']] throughout the transfer. | ||
| You must dispose the returned stream before trying to use the ''Session'' instance again. | You must dispose the returned stream before trying to use the ''Session'' instance again. | ||
| + | |||
| + | Streaming is supported with the [[sftp|SFTP]] and [[ftp|FTP]] protocols only. | ||