LoadFromOSFile(IWritableFileInfo,String,Int32) Method

Loads a file in an abstract writable file provider with a contents of normal (operating system) file.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<ExtensionAttribute()>
Public Overloads Shared Function LoadFromOSFile( _
   ByVal writableFileInfo As IWritableFileInfo, _
   ByVal sourceOSFilePath As String, _
   ByVal copyBufferSize As Integer _
) As Long

'Usage
 
Dim writableFileInfo As IWritableFileInfo
Dim sourceOSFilePath As String
Dim copyBufferSize As Integer
Dim value As Long
 
value = IWritableFileInfoExtension.LoadFromOSFile(writableFileInfo, sourceOSFilePath, copyBufferSize)

[Extension()]
public static long LoadFromOSFile( 
   IWritableFileInfo writableFileInfo,
   string sourceOSFilePath,
   int copyBufferSize
)

[Extension()]
public:
static int64 LoadFromOSFile( 
   IWritableFileInfo^ writableFileInfo,
   String^ sourceOSFilePath,
   int copyBufferSize
)

Parameters

writableFileInfo: The writable file info object that will perform the operation.
sourceOSFilePath: Path and name of the file in the operating system that should be loaded into the file.
copyBufferSize: The size of the copy buffer. This value must be greater than zero. The default size is 81920.

Return Value

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

Exceptions

Exception	Description
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.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.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.

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

IWritableFileInfoExtension Class
IWritableFileInfoExtension Members
Overload List

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