Operator Reference

HALCON Operator Reference / File / Misc
ClassesClasses | | Operators

remove_dirremove_dirRemoveDirRemoveDirremove_dir (Operator)

remove_dirremove_dirRemoveDirRemoveDirremove_dir — Delete an empty directory.

Signature

remove_dir( : : DirName : )

Herror remove_dir(const char* DirName)

Herror T_remove_dir(const Htuple DirName)

void RemoveDir(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 HOperatorSet.RemoveDir(HTuple dirName)

static void HMisc.RemoveDir(string dirName)

def remove_dir(dir_name: str) -> None

Description

remove_dirremove_dirRemoveDirRemoveDirremove_dir deletes the empty directory given by DirNameDirNameDirNamedirNamedir_name.

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

DirNameDirNameDirNamedirNamedir_name (input_control)  filename.dir → HTuplestrHTupleHtuple (string) (string) (HString) (char*)

Name of directory to be deleted.

Result

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

Module

Foundation

ClassesClasses | | Operators