Operator Reference

HALCON Operator Reference / File / Misc

• HDevelop
• .NET
• Python
• C++
• C

ClassesClasses | | Operators

delete_filedelete_fileDeleteFileDeleteFiledelete_file (Operator)

delete_filedelete_fileDeleteFileDeleteFiledelete_file — Delete a file.

Signature

delete_file( : : FileName : )

Herror delete_file(const char* FileName)

Herror T_delete_file(const Htuple FileName)

void DeleteFile(const HTuple& FileName)

static void HMisc::DeleteFile(const HString& FileName)

static void HMisc::DeleteFile(const char* FileName)

static void HMisc::DeleteFile(const wchar_t* FileName)   ( Windows only)

static void HOperatorSet.DeleteFile(HTuple fileName)

static void HMisc.DeleteFile(string fileName)

def delete_file(file_name: str) -> None

Description

delete_filedelete_fileDeleteFileDeleteFiledelete_file deletes the file given by FileNameFileNameFileNamefileNamefile_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

FileNameFileNameFileNamefileNamefile_name (input_control)  filename → HTuplestrHTupleHtuple (string) (string) (HString) (char*)

File to be deleted.

Result

delete_filedelete_fileDeleteFileDeleteFiledelete_file returns the value 2 ( H_MSG_TRUE) if the file exists and could be deleted. Otherwise, an exception is raised.

Module

Foundation

---

ClassesClasses | | Operators