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

get_serialized_item_ptrget_serialized_item_ptrGetSerializedItemPtrGetSerializedItemPtr (Operator)

Name

get_serialized_item_ptrget_serialized_item_ptrGetSerializedItemPtrGetSerializedItemPtr — Access the data pointer of a serialized item.

Warning

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

Signature

get_serialized_item_ptr( : : SerializedItemHandle : Pointer, Size)

Herror get_serialized_item_ptr(const Hlong SerializedItemHandle, Hlong* Pointer, Hlong* Size)

Herror T_get_serialized_item_ptr(const Htuple SerializedItemHandle, Htuple* Pointer, Htuple* Size)

void GetSerializedItemPtr(const HTuple& SerializedItemHandle, HTuple* Pointer, HTuple* Size)

void* HSerializedItem::GetSerializedItemPtr(Hlong* Size) const

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

IntPtr HSerializedItem.GetSerializedItemPtr(out int size)

Description

get_serialized_item_ptrget_serialized_item_ptrGetSerializedItemPtrGetSerializedItemPtrGetSerializedItemPtr returns the data pointer to the serialized item which is passed by 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 returned by the parameter PointerPointerPointerPointerpointer. The size of the serialized item in bytes is passed by the parameter SizeSizeSizeSizesize.

Execution Information

Parameters

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

Handle of the serialized item.

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

Data pointer of the serialized item.

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

Size of the serialized item.

Result

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

Possible Predecessors

create_serialized_item_ptrcreate_serialized_item_ptrCreateSerializedItemPtrCreateSerializedItemPtrCreateSerializedItemPtr

Module

Foundation

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