Operator Reference

HALCON Operator Reference / File / Misc
ClassesClasses | | Operators

set_current_dirset_current_dirSetCurrentDirSetCurrentDirset_current_dir (Operator)

set_current_dirset_current_dirSetCurrentDirSetCurrentDirset_current_dir — Set the current working directory.

Signature

set_current_dir( : : DirName : )

Herror set_current_dir(const char* DirName)

Herror T_set_current_dir(const Htuple DirName)

void SetCurrentDir(const HTuple& DirName)

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

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

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

static void HOperatorSet.SetCurrentDir(HTuple dirName)

static void HMisc.SetCurrentDir(string dirName)

def set_current_dir(dir_name: str) -> None

Description

set_current_dirset_current_dirSetCurrentDirSetCurrentDirset_current_dir sets the current working directory to the directory 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 current working directory to be set.

Result

set_current_dirset_current_dirSetCurrentDirSetCurrentDirset_current_dir returns the value 2 ( H_MSG_TRUE) if the current working directory could be set. Otherwise, an exception is raised.

Module

Foundation

ClassesClasses | | Operators