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

open_fileopen_fileopen_fileOpenFileOpenFile (Operator)

Name

open_fileopen_fileopen_fileOpenFileOpenFile — Open text file.

Signature

open_file( : : FileName, FileType : FileHandle)

Herror open_file(const char* FileName, const char* FileType, Hlong* FileHandle)

Herror T_open_file(const Htuple FileName, const Htuple FileType, Htuple* FileHandle)

Herror open_file(const HTuple& FileName, const HTuple& FileType, Hlong* FileHandle)

void HFile::OpenFile(const HTuple& FileName, const HTuple& FileType)

void HOperatorSetX.OpenFile(
[in] VARIANT FileName, [in] VARIANT FileType, [out] VARIANT* FileHandle)

void HFileX.OpenFile(
[in] BSTR FileName, [in] BSTR FileType)

static void HOperatorSet.OpenFile(HTuple fileName, HTuple fileType, out HTuple fileHandle)

public HFile(string fileName, string fileType)

void HFile.OpenFile(string fileName, string fileType)

Description

The operator open_fileopen_fileopen_fileOpenFileOpenFile opens a file. FileTypeFileTypeFileTypeFileTypefileType determines whether this file is an input ('input'"input""input""input""input") or output file ('output'"output""output""output""output" or 'append'"append""append""append""append"). open_fileopen_fileopen_fileOpenFileOpenFile creates files which can be accessed either by reading ('input'"input""input""input""input") or by writing ('output'"output""output""output""output" or 'append'"append""append""append""append") are created. For terminal input and output the file names 'standard'"standard""standard""standard""standard" ('input'"input""input""input""input" and 'output'"output""output""output""output") and 'error'"error""error""error""error" (only 'output'"output""output""output""output") are reserved.

Parallelization

Parameters

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

Name of file to be opened.

Default value: 'standard' "standard" "standard" "standard" "standard"

Suggested values: 'standard'"standard""standard""standard""standard", 'error'"error""error""error""error", '/tmp/dat.dat'"/tmp/dat.dat""/tmp/dat.dat""/tmp/dat.dat""/tmp/dat.dat"

FileTypeFileTypeFileTypeFileTypefileType (input_control)  string → HTupleHTupleVARIANTHtuple (string) (string) (char*) (BSTR) (char*)

Type of file.

Default value: 'output' "output" "output" "output" "output"

List of values: 'input'"input""input""input""input", 'output'"output""output""output""output", 'append'"append""append""append""append"

FileHandleFileHandleFileHandleFileHandlefileHandle (output_control)  file → HFile, HTupleHFile, HTupleHFileX, VARIANTHtuple (integer) (IntPtr) (Hlong) (Hlong) (Hlong)

File handle.

Example (HDevelop)

* Creating of an outputfile with the name '/tmp/log.txt' and writing
* of one  string:
   open_file('/tmp/log.txt','output',FileHandle)
   fwrite_string(FileHandle,'these are the first and last lines')
   fnew_line(FileHandle)
   close_file(FileHandle)

Example (C)

/* Creating of an outputfile with the name '/tmp/log.txt' and writing */
/* of one  string:                                                    */
   open_file("/tmp/log.txt","output",&FileHandle) ;
   fwrite_string(FileHandle,"these are the first and last lines") ;
   fnew_line(FileHandle) ;
   close_file(FileHandle);

Example (HDevelop)

* Creating of an outputfile with the name '/tmp/log.txt' and writing
* of one  string:
   open_file('/tmp/log.txt','output',FileHandle)
   fwrite_string(FileHandle,'these are the first and last lines')
   fnew_line(FileHandle)
   close_file(FileHandle)

Example (HDevelop)

* Creating of an outputfile with the name '/tmp/log.txt' and writing
* of one  string:
   open_file('/tmp/log.txt','output',FileHandle)
   fwrite_string(FileHandle,'these are the first and last lines')
   fnew_line(FileHandle)
   close_file(FileHandle)

Example (HDevelop)

* Creating of an outputfile with the name '/tmp/log.txt' and writing
* of one  string:
   open_file('/tmp/log.txt','output',FileHandle)
   fwrite_string(FileHandle,'these are the first and last lines')
   fnew_line(FileHandle)
   close_file(FileHandle)

Result

If the parameters are correct the operator open_fileopen_fileopen_fileOpenFileOpenFile returns the value 2 (H_MSG_TRUE). Otherwise an exception is raised.

Possible Successors

fwrite_stringfwrite_stringfwrite_stringFwriteStringFwriteString, fread_charfread_charfread_charFreadCharFreadChar, fread_stringfread_stringfread_stringFreadStringFreadString, fread_linefread_linefread_lineFreadLineFreadLine, close_fileclose_fileclose_fileCloseFileCloseFile

See also

close_fileclose_fileclose_fileCloseFileCloseFile, fwrite_stringfwrite_stringfwrite_stringFwriteStringFwriteString, fread_charfread_charfread_charFreadCharFreadChar, fread_stringfread_stringfread_stringFreadStringFreadString, fread_linefread_linefread_lineFreadLineFreadLine

Module

Foundation

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