SaveToOSFile(IFileInfo,String,Int32) Method

Saves the contents of a file from an abstracted file provider into a normal (operating system) file, specifying copy buffer size.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<ExtensionAttribute()>
Public Overloads Shared Function SaveToOSFile( _
   ByVal fileInfo As IFileInfo, _
   ByVal destinationOSFilePath As String, _
   ByVal copyBufferSize As Integer _
) As Long

'Usage
 
Dim fileInfo As IFileInfo
Dim destinationOSFilePath As String
Dim copyBufferSize As Integer
Dim value As Long
 
value = IFileInfoExtension.SaveToOSFile(fileInfo, destinationOSFilePath, copyBufferSize)

[Extension()]
public static long SaveToOSFile( 
   IFileInfo fileInfo,
   string destinationOSFilePath,
   int copyBufferSize
)

[Extension()]
public:
static int64 SaveToOSFile( 
   IFileInfo^ fileInfo,
   String^ destinationOSFilePath,
   int copyBufferSize
)

Parameters

fileInfo: A file info that represents a file in the file provider.
The value of this parameter cannot be null (Nothing in Visual Basic).
destinationOSFilePath: A path and name of an operating system file where the file contents should be saved.
The value of this parameter cannot be null (Nothing in Visual Basic).
copyBufferSize: The size of the copy buffer. This value must be greater than zero. The default size is 81920.
Valid values of this parameter are in the range from 1 to 2147483647 (Int32.MaxValue).

Return Value

Returns the number of bytes saved, or -1 if it cannot be determined.

Exceptions

Exception	Description
System.ArgumentException	One of the arguments provided to a method is not valid. This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.
System.ArgumentNullException	A `null` reference (`Nothing` in Visual Basic) is passed to a method that does not accept it as a valid argument. This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.
System.ArgumentOutOfRangeException	The value of an argument is outside the allowable range of values as defined by the invoked method. This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.
System.IO.DirectoryNotFoundException	Part of a file or directory cannot be found. This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.
System.IO.IOException	An I/O error has occurred. This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.
System.NotSupportedException	An invoked method is not supported at all, or is not supported with the parameters used to create the object.
System.IO.PathTooLongException	A path or fully qualified file name is longer than the system-defined maximum length. This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.
System.Security.SecurityException	A security error was detected. This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.
System.UnauthorizedAccessException	The operating system has denied access because of an I/O error or a specific type of security error. This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.

Remarks

This is an extension method (info: C#, VB.NET). In languages that have support for extensions methods (such as C# and VB.NET), you can use the extension method as if it were a regular method on the object that is its first parameter. In other languages (such as with Python.NET), you will call the extension as a static method, and pass it the object on which it acts as its first parameter.

Requirements

Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2016, Windows Server 2022; .NET: Linux, macOS, Microsoft Windows

Reference

IFileInfoExtension Class
IFileInfoExtension Members
Overload List

Documentation Home, Send Feedback. Resources: Knowledge Base, Product Downloads. Technical support: Online Forums, FAQ.

Missing some example? Ask us for it on our Online Forums! You do not have to own a commercial license in order to use Online Forums, and we reply to every post.