serialize_objectT_serialize_objectSerializeObjectSerializeObjectserialize_object (Operator)
Name
serialize_objectT_serialize_objectSerializeObjectSerializeObjectserialize_object
— Serialize an iconic object.
Signature
def serialize_object(object: HObject) -> HHandle
Description
serialize_objectserialize_objectSerializeObjectSerializeObjectSerializeObjectserialize_object
serializes an iconic object (see
fwrite_serialized_itemfwrite_serialized_itemFwriteSerializedItemFwriteSerializedItemFwriteSerializedItemfwrite_serialized_item
for an introduction of the basic
principle of serialization). The iconic object is a tuple of image objects,
region objects, or XLD objects, and is defined by the parameter
ObjectObjectObjectObjectobjectValobject
. The serialized iconic object is returned by the handle
SerializedItemHandleSerializedItemHandleSerializedItemHandleSerializedItemHandleserializedItemHandleserialized_item_handle
and can be deserialized by
deserialize_objectdeserialize_objectDeserializeObjectDeserializeObjectDeserializeObjectdeserialize_object
.
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
ObjectObjectObjectObjectobjectValobject
(input_object) object(-array) →
objectHObjectHObjectHObjectHobject
Iconic object.
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
serialize_objectserialize_objectSerializeObjectSerializeObjectSerializeObjectserialize_object
returns the value TRUE. If
necessary, an exception is raised.
Possible Successors
fwrite_serialized_itemfwrite_serialized_itemFwriteSerializedItemFwriteSerializedItemFwriteSerializedItemfwrite_serialized_item
,
send_serialized_itemsend_serialized_itemSendSerializedItemSendSerializedItemSendSerializedItemsend_serialized_item
,
deserialize_objectdeserialize_objectDeserializeObjectDeserializeObjectDeserializeObjectdeserialize_object
See also
deserialize_objectdeserialize_objectDeserializeObjectDeserializeObjectDeserializeObjectdeserialize_object
Module
Foundation