QuickOPC User's Guide and Reference
Delete Method (IWritableFileInfoExtension)



OpcLabs.BaseLib Assembly > OpcLabs.BaseLib.Extensions.FileProviders Namespace > IWritableFileInfoExtension Class : Delete Method
The writable file info object that will perform the operation.
Specifies whether the file must exist for the operation to succeed.
Permanently deletes a file, specifying whether the file must exist.
Syntax
'Declaration
 
<ExtensionAttribute()>
Public Shared Sub Delete( _
   ByVal writableFileInfo As IWritableFileInfo, _
   ByVal mustExist As Boolean _
) 
'Usage
 
Dim writableFileInfo As IWritableFileInfo
Dim mustExist As Boolean
 
IWritableFileInfoExtension.Delete(writableFileInfo, mustExist)
[Extension()]
public static void Delete( 
   IWritableFileInfo writableFileInfo,
   bool mustExist
)
[Extension()]
public:
static void Delete( 
   IWritableFileInfo^ writableFileInfo,
   bool mustExist
) 

Parameters

writableFileInfo
The writable file info object that will perform the operation.
mustExist
Specifies whether the file must exist for the operation to succeed.
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.

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