get_serialized_item_ptrT_get_serialized_item_ptrGetSerializedItemPtrGetSerializedItemPtrget_serialized_item_ptr (Operator)
Name
get_serialized_item_ptrT_get_serialized_item_ptrGetSerializedItemPtrGetSerializedItemPtrget_serialized_item_ptr — Access the data pointer of a serialized item.
Warning
It is not recommended to use the operator
get_serialized_item_ptrget_serialized_item_ptrGetSerializedItemPtrGetSerializedItemPtrGetSerializedItemPtrget_serialized_item_ptr in HDevelop.
Signature
Description
get_serialized_item_ptrget_serialized_item_ptrGetSerializedItemPtrGetSerializedItemPtrGetSerializedItemPtrget_serialized_item_ptr returns the data pointer to the
serialized item which is passed by the handle
SerializedItemHandleSerializedItemHandleSerializedItemHandleSerializedItemHandleserializedItemHandleserialized_item_handle (see fwrite_serialized_itemfwrite_serialized_itemFwriteSerializedItemFwriteSerializedItemFwriteSerializedItemfwrite_serialized_item
for an introduction of the basics of serialization). The
data pointer, i.e., the beginning of the serialized item is returned
by the parameter PointerPointerPointerPointerpointerpointer. The size of the serialized item
in bytes is passed by the parameter SizeSizeSizeSizesizesize.
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
SerializedItemHandleSerializedItemHandleSerializedItemHandleSerializedItemHandleserializedItemHandleserialized_item_handle (input_control) serialized_item → HSerializedItem, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Handle of the serialized item.
PointerPointerPointerPointerpointerpointer (output_control) pointer → HTupleintHTupleHtuple (integer) (IntPtr) (Hlong) (Hlong)
Data pointer of the serialized item.
SizeSizeSizeSizesizesize (output_control) integer → HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)
Size of the serialized item.
Result
If the parameters are valid, the operator
get_serialized_item_ptrget_serialized_item_ptrGetSerializedItemPtrGetSerializedItemPtrGetSerializedItemPtrget_serialized_item_ptr returns the value 2 (
H_MSG_TRUE)
. If
necessary, an exception is raised.
Possible Predecessors
create_serialized_item_ptrcreate_serialized_item_ptrCreateSerializedItemPtrCreateSerializedItemPtrCreateSerializedItemPtrcreate_serialized_item_ptr
Module
Foundation