Skip to content

get_serialized_item_ptrGetSerializedItemPtrGetSerializedItemPtrget_serialized_item_ptrT_get_serialized_item_ptr🔗

Short description🔗

get_serialized_item_ptrGetSerializedItemPtrGetSerializedItemPtrget_serialized_item_ptrT_get_serialized_item_ptr — Access the data pointer of a serialized item.

Warning🔗

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

Signature🔗

get_serialized_item_ptr( serialized_item SerializedItemHandle, out pointer Pointer, out integer Size )void GetSerializedItemPtr( const HTuple& SerializedItemHandle, HTuple* Pointer, HTuple* Size )static void HOperatorSet.GetSerializedItemPtr( HTuple serializedItemHandle, out HTuple pointer, out HTuple size )def get_serialized_item_ptr( serialized_item_handle: HHandle ) -> Tuple[int, int]

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

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

IntPtr HSerializedItem.GetSerializedItemPtr( out int size )

Description🔗

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

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.

Parameters🔗

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

Handle of the serialized item.

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

Data pointer of the serialized item.

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

Size of the serialized item.

Result🔗

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

Combinations with other operators🔗

Combinations

Possible predecessors

create_serialized_item_ptrCreateSerializedItemPtr

Module🔗

Foundation