library_session_getfile » Revisions »

Differences

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

2021-02-26		2021-02-26
moving dispose requirement to remarks (martin)		remarks anchor (martin)
	Line 29:		Line 29:
	''[[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://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.

-	===== 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.