OPC Studio User's Guide and Reference
DeleteExisting Method



OpcLabs.BaseLib Assembly > OpcLabs.BaseLib.Extensions.FileProviders Namespace > IWritableFileInfoExtension Class : DeleteExisting Method
The writable file info object that will perform the operation.
Permanently deletes a file, if it exists.
Syntax
'Declaration
 
<ExtensionAttribute()>
Public Shared Sub DeleteExisting( _
   ByVal writableFileInfo As IWritableFileInfo _
) 
'Usage
 
Dim writableFileInfo As IWritableFileInfo
 
IWritableFileInfoExtension.DeleteExisting(writableFileInfo)
[Extension()]
public static void DeleteExisting( 
   IWritableFileInfo writableFileInfo
)
[Extension()]
public:
static void DeleteExisting( 
   IWritableFileInfo^ writableFileInfo
) 

Parameters

writableFileInfo
The writable file info object that will perform the operation.
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 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 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

If the file does not exist, a System.IO.FileNotFoundException is thrown. If you want to silently ignore a non-existent file, use the IWritableFileInfo.Delete method instead.

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