Skip to content

remove_dirRemoveDirRemoveDirremove_dirremove_dir🔗

Short description🔗

remove_dirRemoveDirRemoveDirremove_dirremove_dir — Delete an empty directory.

Signature🔗

remove_dir( filename.dir DirName )void RemoveDir( const HTuple& DirName )static void HOperatorSet.RemoveDir( HTuple dirName )def remove_dir( dir_name: str ) -> None

Herror remove_dir( const char* DirName )

Herror T_remove_dir( const Htuple DirName )

static void HMisc::RemoveDir( const HString& DirName )

static void HMisc::RemoveDir( const char* DirName )

static void HMisc::RemoveDir( const wchar_t* DirName ) (Windows only)

static void HMisc.RemoveDir( string dirName )

Description🔗

remove_dirRemoveDir deletes the empty directory given by DirNamedirNamedir_name.

Execution information🔗

Execution information

  • Multithreading type: reentrant (runs in parallel with non-exclusive operators).

  • Multithreading scope: global (may be called from any thread).

  • Processed without parallelization.

Parameters🔗

DirNamedirNamedir_name (input_control) filename.dir → (string)HTuple (HString)HTuple (string)strHtuple (char*)

Name of directory to be deleted.

Result🔗

remove_dirRemoveDir returns the value 2 (H_MSG_TRUE) if the directory could be deleted. Otherwise, an exception is raised.

Module🔗

Foundation