OPC Studio User's Guide and Reference
MoveTo Method (IWritableFileInfoExtension)



OpcLabs.BaseLib Assembly > OpcLabs.BaseLib.Extensions.FileProviders Namespace > IWritableFileInfoExtension Class : MoveTo Method
The writable file info object that will perform the operation.
The path to move the file to, which can specify a different file name.
Moves a specified file to a new location, providing the option to specify a new file name.
Syntax
'Declaration
 
<ExtensionAttribute()>
Public Shared Sub MoveTo( _
   ByVal writableFileInfo As IWritableFileInfo, _
   ByVal destinationFilePathAndName As String _
) 
'Usage
 
Dim writableFileInfo As IWritableFileInfo
Dim destinationFilePathAndName As String
 
IWritableFileInfoExtension.MoveTo(writableFileInfo, destinationFilePathAndName)

Parameters

writableFileInfo
The writable file info object that will perform the operation.
destinationFilePathAndName
The path to move the file to, which can specify a different file name.
Exceptions
ExceptionDescription

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.

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.

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

Remarks

This method is similar in purpose to System.IO.FileInfo.MoveTo(System.String), but is generalized for any kind of writable file info, not just files in the physical file system.

You can use this method to rename a file, keeping it in the same parent directory, too.

This method can be used with an absolute path pointing in destinationFilePathAndName.

This method does not overwrite the destination file if it already exists. For that purpose, call IWritableFileInfo.MoveTo instead.

For Microsoft.Extensions.FileProviders.IFileInfo, IFileInfo2 and IWritableFileInfo, relative paths are based on the directory where the file is located; absolute paths are based on the root directory of the file provider.

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

Reference

IWritableFileInfoExtension Class
IWritableFileInfoExtension Members
OpcLabs.BaseLib.Extensions.FileProviders.IWritableFileInfoExtension.CopyTo(OpcLabs.BaseLib.Extensions.FileProviders.IWritableFileInfo,System.String)
MoveTo Method