serialize_objectT_serialize_objectSerializeObjectSerializeObjectserialize_object (Operator)

Name

serialize_objectT_serialize_objectSerializeObjectSerializeObjectserialize_object — Serialize an iconic object.

Signature

serialize_object(Object : : : SerializedItemHandle)

Description

serialize_objectserialize_objectSerializeObjectSerializeObjectserialize_object serializes an iconic object (see fwrite_serialized_itemfwrite_serialized_itemFwriteSerializedItemFwriteSerializedItemfwrite_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 ObjectObjectObjectobjectValobject. The serialized iconic object is returned by the handle SerializedItemHandleSerializedItemHandleSerializedItemHandleserializedItemHandleserialized_item_handle and can be deserialized by deserialize_objectdeserialize_objectDeserializeObjectDeserializeObjectdeserialize_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

ObjectObjectObjectobjectValobject (input_object) object(-array) → object

Iconic object.

SerializedItemHandleSerializedItemHandleSerializedItemHandleserializedItemHandleserialized_item_handle (output_control) serialized_item → (handle)

Handle of the serialized item.

Result

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

Possible Successors

fwrite_serialized_itemfwrite_serialized_itemFwriteSerializedItemFwriteSerializedItemfwrite_serialized_item, send_serialized_itemsend_serialized_itemSendSerializedItemSendSerializedItemsend_serialized_item, deserialize_objectdeserialize_objectDeserializeObjectDeserializeObjectdeserialize_object

Module

Foundation

Operators