create_serialized_item_ptrT_create_serialized_item_ptrCreateSerializedItemPtrCreateSerializedItemPtrcreate_serialized_item_ptr (Operator)
Name
create_serialized_item_ptrT_create_serialized_item_ptrCreateSerializedItemPtrCreateSerializedItemPtrcreate_serialized_item_ptr — Create a serialized item.
Warning
It is not recommended to use the operator
create_serialized_item_ptrcreate_serialized_item_ptrCreateSerializedItemPtrCreateSerializedItemPtrCreateSerializedItemPtrcreate_serialized_item_ptr in HDevelop.
Signature
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::HSerializedItem(void* Pointer, Hlong Size, const wchar_t* Copy)
(
Windows only)
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)
def create_serialized_item_ptr(pointer: int, size: int, copy: str) -> HHandle
Description
create_serialized_item_ptrcreate_serialized_item_ptrCreateSerializedItemPtrCreateSerializedItemPtrCreateSerializedItemPtrcreate_serialized_item_ptr creates a serialized item
and returns 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 passed by the parameter PointerPointerPointerPointerpointerpointer.
The size of the serialized item in bytes is passed by parameter
SizeSizeSizeSizesizesize. The behavior of the operator is controlled by the
parameter CopyCopyCopyCopycopycopy. If CopyCopyCopyCopycopycopy is set to 'true'"true""true""true""true""true",
a new serialized item is created and the values of the existing
serialized item are copied. If CopyCopyCopyCopycopycopy is set to
'false'"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 CopyCopyCopyCopycopycopy is set to 'false'"false""false""false""false""false", the data
pointer of the serialized item must not be deleted during using the
new serialized item.
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
PointerPointerPointerPointerpointerpointer (input_control) pointer → HTupleintHTupleHtuple (integer) (IntPtr) (Hlong) (Hlong)
Data pointer of the serialized item.
SizeSizeSizeSizesizesize (input_control) integer → HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)
Size of the serialized item.
CopyCopyCopyCopycopycopy (input_control) string → HTuplestrHTupleHtuple (string) (string) (HString) (char*)
Copy mode of the serialized item.
Default:
'true'
"true"
"true"
"true"
"true"
"true"
List of values:
'false'"false""false""false""false""false", 'true'"true""true""true""true""true"
SerializedItemHandleSerializedItemHandleSerializedItemHandleSerializedItemHandleserializedItemHandleserialized_item_handle (output_control) serialized_item → HSerializedItem, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Handle of the serialized item.
Result
If the parameters are valid, the operator
create_serialized_item_ptrcreate_serialized_item_ptrCreateSerializedItemPtrCreateSerializedItemPtrCreateSerializedItemPtrcreate_serialized_item_ptr returns the value 2 (
H_MSG_TRUE)
. If
necessary, an exception is raised.
Possible Successors
get_serialized_item_ptrget_serialized_item_ptrGetSerializedItemPtrGetSerializedItemPtrGetSerializedItemPtrget_serialized_item_ptr
Module
Foundation