HALCON Reference Manual 10.0.2
Table of Contents / File / Misc ClassesClassesClasses | | | Operators

delete_filedelete_filedelete_fileDeleteFileDeleteFile (Operator)

Name

delete_filedelete_filedelete_fileDeleteFileDeleteFile — Delete a file.

Signature

delete_file( : : FileName : )

Herror delete_file(const char* FileName)

Herror T_delete_file(const Htuple FileName)

Herror delete_file(const HTuple& FileName)

void HOperatorSetX.DeleteFile([in] VARIANT FileName)

void HMiscX.DeleteFile([in] BSTR FileName)

static void HOperatorSet.DeleteFile(HTuple fileName)

static void HMisc.DeleteFile(string fileName)

Description

delete_filedelete_filedelete_fileDeleteFileDeleteFile deletes the file given by FileNameFileNameFileNameFileNamefileName.

Parallelization

Parameters

FileNameFileNameFileNameFileNamefileName (input_control)  filename → HTupleHTupleVARIANTHtuple (string) (string) (char*) (BSTR) (char*)

Name of file to be checked.

Result

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

Module

Foundation

Table of Contents / File / Misc ClassesClassesClasses | | | Operators
HALCON Reference Manual 10.0.2 Copyright © 1996-2011 MVTec Software GmbH