HALCON 17.12 / HALCON Operator Reference / System / Serialized Item
ClassesClasses | | Operators

create_serialized_item_ptrcreate_serialized_item_ptrCreateSerializedItemPtrCreateSerializedItemPtr (Operator)

Name

create_serialized_item_ptrcreate_serialized_item_ptrCreateSerializedItemPtrCreateSerializedItemPtr — Create a serialized item.

Warning

It is not recommended to use the operator create_serialized_item_ptrcreate_serialized_item_ptrCreateSerializedItemPtrCreateSerializedItemPtrCreateSerializedItemPtr in HDevelop.

Signature

create_serialized_item_ptr( : : Pointer, Size, Copy : SerializedItemHandle)

Herror create_serialized_item_ptr(const Hlong Pointer, const Hlong Size, const char* Copy, Hlong* SerializedItemHandle)

Herror T_create_serialized_item_ptr(const Htuple Pointer, const Htuple Size, const Htuple Copy, Htuple* SerializedItemHandle)

void CreateSerializedItemPtr(const HTuple& Pointer, const HTuple& Size, const HTuple& Copy, HTuple* SerializedItemHandle)

void HSerializedItem::HSerializedItem(void* Pointer, Hlong Size, const HString& Copy)

void HSerializedItem::HSerializedItem(void* Pointer, Hlong Size, const char* Copy)

void HSerializedItem::CreateSerializedItemPtr(void* Pointer, Hlong Size, const HString& Copy)

void HSerializedItem::CreateSerializedItemPtr(void* Pointer, Hlong Size, const char* Copy)

static void HOperatorSet.CreateSerializedItemPtr(HTuple pointer, HTuple size, HTuple copy, out HTuple serializedItemHandle)

public HSerializedItem(IntPtr pointer, int size, string copy)

void HSerializedItem.CreateSerializedItemPtr(IntPtr pointer, int size, string copy)

Description

create_serialized_item_ptrcreate_serialized_item_ptrCreateSerializedItemPtrCreateSerializedItemPtrCreateSerializedItemPtr creates a serialized item and returns the handle SerializedItemHandleSerializedItemHandleSerializedItemHandleSerializedItemHandleserializedItemHandle (see fwrite_serialized_itemfwrite_serialized_itemFwriteSerializedItemFwriteSerializedItemFwriteSerializedItem for an introduction of the basics of serialization). The data pointer, i.e., the beginning of the serialized item, is passed by the parameter PointerPointerPointerPointerpointer. The size of the serialized item in bytes is passed by parameter SizeSizeSizeSizesize. The behavior of the operator is controlled by the parameter CopyCopyCopyCopycopy. If CopyCopyCopyCopycopy is set to 'true'"true""true""true""true", a new serialized item is created and the values of the existing serialized item are copied. If CopyCopyCopyCopycopy is set to 'false'"false""false""false""false", only the data pointer of the input serialized item is stored, i.e., the actual data are not copied, which leads to shorter execution times.

Attention

If the parameter CopyCopyCopyCopycopy is set to 'false'"false""false""false""false", the data pointer of the serialized item must not be deleted during using the new serialized item.

Execution Information

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

PointerPointerPointerPointerpointer (input_control)  pointer → HTupleHTupleHtuple (integer) (IntPtr) (Hlong) (Hlong)

Data pointer of the serialized item.

SizeSizeSizeSizesize (input_control)  integer → HTupleHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Size of the serialized item.

CopyCopyCopyCopycopy (input_control)  string → HTupleHTupleHtuple (string) (string) (HString) (char*)

Copy mode of the serialized item.

Default value: 'true' "true" "true" "true" "true"

List of values: 'false'"false""false""false""false", 'true'"true""true""true""true"

SerializedItemHandleSerializedItemHandleSerializedItemHandleSerializedItemHandleserializedItemHandle (output_control)  serialized_item → HSerializedItem, HTupleHTupleHtuple (integer) (IntPtr) (Hlong) (Hlong)

Handle of the serialized item.

Result

If the parameters are valid, the operator create_serialized_item_ptrcreate_serialized_item_ptrCreateSerializedItemPtrCreateSerializedItemPtrCreateSerializedItemPtr returns the value 2 (H_MSG_TRUE). If necessary, an exception is raised.

Possible Successors

get_serialized_item_ptrget_serialized_item_ptrGetSerializedItemPtrGetSerializedItemPtrGetSerializedItemPtr

Module

Foundation

ClassesClasses | | Operators
HALCON Operator Reference 17.12 Copyright © 1996-2017 MVTec Software GmbH