IOMiscUtils.EnsureDirectoryDeleted Method

IOMiscUtils EnsureDirectoryDeleted Method

NFX Class Library

[This is preliminary documentation and is subject to change.]

Tries to delete the specified directory if it exists BLOCKING for up to the specified interval until directory is PHYSICALLY deleted. Returns true when directory either did not exist in the first place or was successfully deleted (with confirmation). Returns false when directory could not be confirmed to be deleted within the specified timeout, this does not mean that the OS will not delete the directory later, so calling this function in a loop is expected. NOTE: Directory.Delete() does not guarantee that directory is no longer on disk upon its return

Namespace: NFX
Assembly: NFX (in NFX.dll) Version: 3.0.0.1 (3.0.0.1)

Syntax

C++

Copy to Clipboard Print

public static bool EnsureDirectoryDeleted(
	string dirName,
	int timeoutMs = 2000
)

public static bool EnsureDirectoryDeleted(
	string dirName,
	int timeoutMs = 2000
)

Public Shared Function EnsureDirectoryDeleted ( 
	dirName As String,
	Optional timeoutMs As Integer = 2000
) As Boolean

Public Shared Function EnsureDirectoryDeleted ( 
	dirName As String,
	Optional timeoutMs As Integer = 2000
) As Boolean

public:
static bool EnsureDirectoryDeleted(
	String^ dirName, 
	int timeoutMs = 2000
)

public:
static bool EnsureDirectoryDeleted(
	String^ dirName, 
	int timeoutMs = 2000
)

static member EnsureDirectoryDeleted : 
        dirName : string * 
        ?timeoutMs : int 
(* Defaults:
        let _timeoutMs = defaultArg timeoutMs 2000
*)
-> bool

static member EnsureDirectoryDeleted : 
        dirName : string * 
        ?timeoutMs : int 
(* Defaults:
        let _timeoutMs = defaultArg timeoutMs 2000
*)
-> bool

Parameters

dirName: Type: System String
Directory to delete

timeoutMs (Optional): Type: System Int32
Timeout in ms

Return Value

Type:

Boolean