Deletes an existing empty directory. This function will fail if any part of lpPathName is redirected via a reparse point or symbolic link.
To perform this operation as a transacted operation, use the RemoveDirectoryTransacted function.
SyntaxBOOL RemoveDirectory2A(
LPCSTR lpPathName,
DIRECTORY_FLAGS DirectoryFlags
);
lpPathName
The path of the directory to be removed. This path must specify an empty directory, and the calling process must have delete access to the directory.
By default, the name is limited to MAX_PATH characters. To extend this limit to 32,767 wide characters, prepend "\\?\" to the path. For more information, see Naming Files, Paths, and Namespaces.
Tip
You can opt-in to remove the MAX_PATH limitation without prepending "\\?\". See the "Maximum Path Length Limitation" section of Naming Files, Paths, and Namespaces for details.
DirectoryFlags
Flags that specify how the directory is to be deleted. This parameter can be a combination of the following values:
Value Meaning DIRECTORY_FLAGS_DISALLOW_PATH_REDIRECTS0x00000001 Prevent lpPathName from being redirected by reparse points or symbolic links. Return value
If the function succeeds, the return value is nonzero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.
The RemoveDirectory2 function marks a directory for deletion on close. Therefore, the directory is not removed until the last handle to the directory is closed.
To recursively delete the files in a directory, use the SHFileOperation function.
RemoveDirectory2 can be used to remove a directory junction. Since the target directory and its contents will remain accessible through its canonical path, the target directory itself is not affected by removing a junction which targets it. For this reason, when lpPathName refers to a directory junction, RemoveDirectory2 will remove the specified link regardless of whether the target directory is empty or not. For more information on junctions, see Hard Links and Junctions.
The use of POSIX delete causes the directory to be deleted while handles remain open. Subsequent calls to CreateDirectory or CreateDirectory2 to open the directory fail with ERROR_FILE_NOT_FOUND.
This function is supported by the following technologies:
Technology Supported Server Message Block (SMB) 3.0 protocol Yes SMB 3.0 Transparent Failover (TFO) Yes SMB 3.0 with Scale-out File Shares (SO) Yes Cluster Shared Volume File System (CsvFS) Yes Resilient File System (ReFS) YesNote
The fileapi.h header defines RemoveDirectory2 as an alias that automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that is not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.
Creating and Deleting Directories
Directory Management Functions
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4