write_tuplewrite_tupleWriteTupleWriteTuple (Operator)

Name

write_tuplewrite_tupleWriteTupleWriteTuple — Write a tuple to a file.

Signature

write_tuple( : : Tuple, FileName : )

Description

The operator write_tuplewrite_tupleWriteTupleWriteTupleWriteTuple writes the contents of TupleTupleTupleTupletuple to a file. The data is written in an ASCII format. Therefore, the file can be exchanged between different architectures (see also Tuple / String Operations). The default HALCON file extension for the tuple is 'tup'.

Note that write_tuplewrite_tupleWriteTupleWriteTupleWriteTuple does not support handles, since binary data is not supported by the underlying ASCII format. An exception is raised when passing a tuple that contains handles. To write a tuple that contains handles, use serialize_tupleserialize_tupleSerializeTupleSerializeTupleSerializeTuple and fwrite_serialized_itemfwrite_serialized_itemFwriteSerializedItemFwriteSerializedItemFwriteSerializedItem.

Execution Information

Multithreading type: independent (runs in parallel even with exclusive operators).
Multithreading scope: global (may be called from any thread).
Processed without parallelization.

Parameters

TupleTupleTupleTupletuple (input_control) tuple(-array) → (real / integer / string)

Tuple with any kind of data.

FileNameFileNameFileNameFileNamefileName (input_control) filename.write → (string)

Name of the file to be written.

File extension: .tup

Result

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

Alternatives

fwrite_stringfwrite_stringFwriteStringFwriteStringFwriteString

Module

Foundation

Operators