Operator Reference

HALCON Operator Reference / System / Serialized Item

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

ClassesClasses | | Operators

fread_serialized_itemT_fread_serialized_itemFreadSerializedItemFreadSerializedItemfread_serialized_item (Operator)

fread_serialized_itemT_fread_serialized_itemFreadSerializedItemFreadSerializedItemfread_serialized_item — Read a serialized item from a file.

Signature

fread_serialized_item( : : FileHandle : SerializedItemHandle)

Herror T_fread_serialized_item(const Htuple FileHandle, Htuple* SerializedItemHandle)

void FreadSerializedItem(const HTuple& FileHandle, HTuple* SerializedItemHandle)

void HSerializedItem::FreadSerializedItem(const HFile& FileHandle)

static void HOperatorSet.FreadSerializedItem(HTuple fileHandle, out HTuple serializedItemHandle)

void HSerializedItem.FreadSerializedItem(HFile fileHandle)

def fread_serialized_item(file_handle: HHandle) -> HHandle

Description

fread_serialized_itemfread_serialized_itemFreadSerializedItemFreadSerializedItemfread_serialized_item reads a serialized item, that was written by fwrite_serialized_itemfwrite_serialized_itemFwriteSerializedItemFwriteSerializedItemfwrite_serialized_item from the current input file with the file handle FileHandleFileHandleFileHandlefileHandlefile_handle (see fwrite_serialized_itemfwrite_serialized_itemFwriteSerializedItemFwriteSerializedItemfwrite_serialized_item for an introduction of the basics of serialization). For this, a serialized item is created and the values read from file are stored in the serialized item. The operator returns the handle of the serialized item in the parameter SerializedItemHandleSerializedItemHandleSerializedItemHandleserializedItemHandleserialized_item_handle. The file can be opened by the operator open_fileopen_fileOpenFileOpenFileopen_file. Note that the file must be open in binary format. For reading more than on item from one file the operator fread_serialized_itemfread_serialized_itemFreadSerializedItemFreadSerializedItemfread_serialized_item must be called several times.

Execution Information

• Multithreading type: reentrant (runs in parallel with non-exclusive operators).
• Multithreading scope: global (may be called from any thread).
• Processed without parallelization.

This operator returns a handle. Note that the state of an instance of this handle type may be changed by specific operators even though the handle is used as an input parameter by those operators.

Parameters

FileHandleFileHandleFileHandlefileHandlefile_handle (input_control)  file → HFile, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

File handle.

SerializedItemHandleSerializedItemHandleSerializedItemHandleserializedItemHandleserialized_item_handle (output_control)  serialized_item → HSerializedItem, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handle of the serialized item.

Result

If the parameters are valid, the operator fread_serialized_itemfread_serialized_itemFreadSerializedItemFreadSerializedItemfread_serialized_item returns the value 2 ( H_MSG_TRUE) . If necessary, an exception is raised. The error code 9581 indicates that the end of file is reached before a serialized item could be read.

Possible Predecessors

open_fileopen_fileOpenFileOpenFileopen_file, fwrite_serialized_itemfwrite_serialized_itemFwriteSerializedItemFwriteSerializedItemfwrite_serialized_item

Possible Successors

close_fileclose_fileCloseFileCloseFileclose_file, get_serialized_item_ptrget_serialized_item_ptrGetSerializedItemPtrGetSerializedItemPtrget_serialized_item_ptr, deserialize_shape_modeldeserialize_shape_modelDeserializeShapeModelDeserializeShapeModeldeserialize_shape_model, deserialize_ncc_modeldeserialize_ncc_modelDeserializeNccModelDeserializeNccModeldeserialize_ncc_model

Module

Foundation

---

ClassesClasses | | Operators