delete_fileDeleteFileDeleteFiledelete_filedelete_file

HALCON ScriptCpp++.NETPythonC

Short description

delete_fileDeleteFileDeleteFiledelete_filedelete_file — Delete a file.

Signature

delete_file( filename FileName )void DeleteFile( const HTuple& FileName )static void HOperatorSet.DeleteFile( HTuple fileName )def delete_file( file_name: str ) -> None

Herror delete_file( const char* FileName )

Herror T_delete_file( 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 HMisc.DeleteFile( string fileName )

Description

delete_fileDeleteFile deletes the file given by FileNamefileNamefile_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

FileNamefileNamefile_name (input_control) filename → (string)HTuple (HString)HTuple (string)strHtuple (char*)

File to be deleted.

Result

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

Module

Foundation