OPC Studio User's Guide and Reference
CopyToWritableFileInfo(IFileInfo,IWritableFileInfo,Int32) Method



OpcLabs.BaseLib Assembly > OpcLabs.BaseLib.Extensions.FileProviders Namespace > IFileInfoExtension Class > CopyToWritableFileInfo Method : CopyToWritableFileInfo(IFileInfo,IWritableFileInfo,Int32) Method
The file info object that will perform the operation.
The writable file info into which the file will be copied.
The size of the copy buffer. This value must be greater than zero. The default size is 81920.
Copies the file represented by a file info to a destination writable file info.
Syntax
'Declaration
 
<ExtensionAttribute()>
Public Overloads Shared Function CopyToWritableFileInfo( _
   ByVal fileInfo As IFileInfo, _
   ByVal destinationWritableFileInfo As IWritableFileInfo, _
   ByVal copyBufferSize As Integer _
) As Long
'Usage
 
Dim fileInfo As IFileInfo
Dim destinationWritableFileInfo As IWritableFileInfo
Dim copyBufferSize As Integer
Dim value As Long
 
value = IFileInfoExtension.CopyToWritableFileInfo(fileInfo, destinationWritableFileInfo, copyBufferSize)

Parameters

fileInfo
The file info object that will perform the operation.
destinationWritableFileInfo
The writable file info into which the file will be copied.
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 copied.
Exceptions
ExceptionDescription

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.

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.

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.

An attempt to access a file that does not exist on disk has failed.

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.

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.

An invoked method is not supported at all, or is not supported with the parameters used to create the object.

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.

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.

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

See Also