create_serialized_item_ptrCreateSerializedItemPtrCreateSerializedItemPtrcreate_serialized_item_ptrT_create_serialized_item_ptr

HALCON ScriptCpp++.NETPythonC

Short description

create_serialized_item_ptrCreateSerializedItemPtrCreateSerializedItemPtrcreate_serialized_item_ptrT_create_serialized_item_ptr — Create a serialized item.

Warning

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

Signature

create_serialized_item_ptr( pointer Pointer, integer Size, string Copy, out serialized_item SerializedItemHandle )void CreateSerializedItemPtr( const HTuple& Pointer, const HTuple& Size, const HTuple& Copy, HTuple* SerializedItemHandle )static void HOperatorSet.CreateSerializedItemPtr( HTuple pointer, HTuple size, HTuple copy, out HTuple serializedItemHandle )def create_serialized_item_ptr( pointer: int, size: int, copy: str ) -> HHandle

Herror T_create_serialized_item_ptr( 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::HSerializedItem( void* Pointer, Hlong Size, const wchar_t* Copy ) (Windows only)

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

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

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

void HSerializedItem::CreateSerializedItemPtr( void* Pointer, Hlong Size, const wchar_t* Copy ) (Windows only)

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

Description

create_serialized_item_ptrCreateSerializedItemPtr creates a serialized item and returns the handle SerializedItemHandleserializedItemHandleserialized_item_handle (see fwrite_serialized_itemFwriteSerializedItem for an introduction of the basics of serialization). The data pointer, i.e., the beginning of the serialized item, is passed by the parameter Pointerpointerpointer. The size of the serialized item in bytes is passed by parameter Sizesizesize. The behavior of the operator is controlled by the parameter Copycopycopy. If Copycopycopy is set to 'true'"true", a new serialized item is created and the values of the existing serialized item are copied. If Copycopycopy is set to '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 Copycopycopy is set to 'false'"false", the data pointer of the serialized item must not be deleted during using the new serialized item.

Execution information

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

Pointerpointerpointer (input_control) pointer → (integer)HTuple (Hlong)HTuple (IntPtr)intHtuple (Hlong)

Data pointer of the serialized item.

Sizesizesize (input_control) integer → (integer)HTuple (Hlong)HTuple (int / long)intHtuple (Hlong)

Size of the serialized item.

Copycopycopy (input_control) string → (string)HTuple (HString)HTuple (string)strHtuple (char*)

Copy mode of the serialized item.

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

SerializedItemHandleserializedItemHandleserialized_item_handle (output_control) serialized_item → (handle)HTuple (HHandle)HSerializedItem, HTuple (IntPtr)HHandleHtuple (handle)

Handle of the serialized item.

Result

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

Combinations with other operators

Combinations

Possible successors

get_serialized_item_ptrGetSerializedItemPtr

Module

Foundation