FileSystemProxy.DeleteFile Method

Definition

Namespace:

Microsoft.VisualBasic.MyServices

Assembly:

Microsoft.VisualBasic.Forms.dll

Deletes a file.

Overloads

DeleteFile(String)	Deletes a file.
DeleteFile(String, UIOption, RecycleOption)	Deletes a file.
DeleteFile(String, UIOption, RecycleOption, UICancelOption)	Deletes a file.

DeleteFile(String)

Source:

FileSystemProxy.vb

Deletes a file.

public:
 void DeleteFile(System::String ^ file);

public void DeleteFile (string file);

member this.DeleteFile : string -> unit

Public Sub DeleteFile (file As String)

Parameters

file

String

Name and path of the file to be deleted.

Exceptions

ArgumentException

The path is not valid for one of the following reasons: it is a zero-length string; it contains only white space; it contains invalid characters; it has a trailing slash where a file must be specified; or it is a device path (starts with \\.\).

ArgumentNullException

file is Nothing or an empty string.

PathTooLongException

The path exceeds the system-defined maximum length.

NotSupportedException

A file or directory name in the path contains a colon (:) or is in an invalid format.

IOException

The file is in use.

SecurityException

The user lacks necessary permissions to view the path.

FileNotFoundException

The file does not exist.

UnauthorizedAccessException

The user does not have permission to delete the file or the file is read-only.

Examples

This example deletes the file Test.txt.

My.Computer.FileSystem.DeleteFile("C:\test.txt")

This example deletes the file Test.txt and allows the user to confirm that the file should be deleted.

My.Computer.FileSystem.DeleteFile(
  "C:\test.txt",
  FileIO.UIOption.AllDialogs,
  FileIO.RecycleOption.SendToRecycleBin,
  FileIO.UICancelOption.ThrowException)

This example deletes the file Test.txt and sends it to the Recycle Bin.

My.Computer.FileSystem.DeleteFile(
  "C:\test.txt",
  FileIO.UIOption.OnlyErrorDialogs,
  FileIO.RecycleOption.SendToRecycleBin,
  FileIO.UICancelOption.ThrowException)

Remarks

The following table lists examples of tasks involving the My.Computer.FileSystem.DeleteFile method.

To	See
To delete a file	How to: Delete a File

See also

• Objects (Visual Basic)
• How to: Delete a File in Visual Basic

DeleteFile(String, UIOption, RecycleOption)

Source:

FileSystemProxy.vb

Deletes a file.

public:
 void DeleteFile(System::String ^ file, Microsoft::VisualBasic::FileIO::UIOption showUI, Microsoft::VisualBasic::FileIO::RecycleOption recycle);

public void DeleteFile (string file, Microsoft.VisualBasic.FileIO.UIOption showUI, Microsoft.VisualBasic.FileIO.RecycleOption recycle);

member this.DeleteFile : string * Microsoft.VisualBasic.FileIO.UIOption * Microsoft.VisualBasic.FileIO.RecycleOption -> unit

Public Sub DeleteFile (file As String, showUI As UIOption, recycle As RecycleOption)

Parameters

file

String

Name and path of the file to be deleted.

showUI

UIOption

Whether to visually track the operation's progress. Default is UIOption.OnlyErrorDialogs.

recycle

RecycleOption

Whether or not the deleted file should be sent to the Recycle Bin. Default is RecycleOption.DeletePermanently.

Exceptions

ArgumentException

The path is not valid for one of the following reasons: it is a zero-length string; it contains only white space; it contains invalid characters; it has a trailing slash where a file must be specified; or it is a device path (starts with \\.\).

ArgumentNullException

file is Nothing or an empty string.

PathTooLongException

The path exceeds the system-defined maximum length.

NotSupportedException

A file or directory name in the path contains a colon (:) or is in an invalid format.

IOException

The file is in use.

SecurityException

The user lacks necessary permissions to view the path.

FileNotFoundException

The file does not exist.

UnauthorizedAccessException

The user does not have permission to delete the file or the file is read-only.

Examples

This example deletes the file Test.txt.

My.Computer.FileSystem.DeleteFile("C:\test.txt")

This example deletes the file Test.txt and allows the user to confirm that the file should be deleted.

My.Computer.FileSystem.DeleteFile(
  "C:\test.txt",
  FileIO.UIOption.AllDialogs,
  FileIO.RecycleOption.SendToRecycleBin,
  FileIO.UICancelOption.ThrowException)

This example deletes the file Test.txt and sends it to the Recycle Bin.

My.Computer.FileSystem.DeleteFile(
  "C:\test.txt",
  FileIO.UIOption.OnlyErrorDialogs,
  FileIO.RecycleOption.SendToRecycleBin,
  FileIO.UICancelOption.ThrowException)

Remarks

The showUI and recycle parameters are not supported in applications that are not user interactive, such as Windows Services.

The following table lists examples of tasks involving the My.Computer.FileSystem.DeleteFile method.

To	See
To delete a file	How to: Delete a File

See also

• RecycleOption
• UIOption
• Objects (Visual Basic)
• How to: Delete a File in Visual Basic

DeleteFile(String, UIOption, RecycleOption, UICancelOption)

Source:

FileSystemProxy.vb

Deletes a file.

public:
 void DeleteFile(System::String ^ file, Microsoft::VisualBasic::FileIO::UIOption showUI, Microsoft::VisualBasic::FileIO::RecycleOption recycle, Microsoft::VisualBasic::FileIO::UICancelOption onUserCancel);

public void DeleteFile (string file, Microsoft.VisualBasic.FileIO.UIOption showUI, Microsoft.VisualBasic.FileIO.RecycleOption recycle, Microsoft.VisualBasic.FileIO.UICancelOption onUserCancel);

member this.DeleteFile : string * Microsoft.VisualBasic.FileIO.UIOption * Microsoft.VisualBasic.FileIO.RecycleOption * Microsoft.VisualBasic.FileIO.UICancelOption -> unit

Public Sub DeleteFile (file As String, showUI As UIOption, recycle As RecycleOption, onUserCancel As UICancelOption)

Parameters

file

String

Name and path of the file to be deleted.

showUI

UIOption

Whether to visually track the operation's progress. Default is UIOption.OnlyErrorDialogs.

recycle

RecycleOption

Whether or not the deleted file should be sent to the Recycle Bin. Default is RecycleOption.DeletePermanently.

onUserCancel

UICancelOption

Specifies whether or not an exception is thrown when the user cancels the operation. Default is UICancelOption.ThrowException.

Exceptions

ArgumentException

The path is not valid for one of the following reasons: it is a zero-length string; it contains only white space; it contains invalid characters; it has a trailing slash where a file must be specified; or it is a device path (starts with \\.\).

ArgumentNullException

file is Nothing or an empty string.

PathTooLongException

The path exceeds the system-defined maximum length.

NotSupportedException

A file or directory name in the path contains a colon (:) or is in an invalid format.

IOException

The file is in use.

SecurityException

The user lacks necessary permissions to view the path.

FileNotFoundException

The file does not exist.

UnauthorizedAccessException

The user does not have permission to delete the file or the file is read-only.

OperationCanceledException

The user cancelled the operation and onUserCancel is set to ThrowException.

Examples

This example deletes the file Test.txt.

My.Computer.FileSystem.DeleteFile("C:\test.txt")

This example deletes the file Test.txt and allows the user to confirm that the file should be deleted.

My.Computer.FileSystem.DeleteFile(
  "C:\test.txt",
  FileIO.UIOption.AllDialogs,
  FileIO.RecycleOption.SendToRecycleBin,
  FileIO.UICancelOption.ThrowException)

This example deletes the file Test.txt and sends it to the Recycle Bin.

My.Computer.FileSystem.DeleteFile(
  "C:\test.txt",
  FileIO.UIOption.OnlyErrorDialogs,
  FileIO.RecycleOption.SendToRecycleBin,
  FileIO.UICancelOption.ThrowException)

Remarks

The showUI, recycle, and onUserCancel parameters are not supported in applications that are not user interactive, such as Windows Services.

The following table lists examples of tasks involving the My.Computer.FileSystem.DeleteFile method.

To	See
To delete a file	How to: Delete a File

See also

• UICancelOption
• RecycleOption
• UIOption
• Objects (Visual Basic)
• How to: Delete a File in Visual Basic