serialize_objectserialize_objectSerializeObjectSerializeObject (Operator)

Name

serialize_objectserialize_objectSerializeObjectSerializeObject — Serialize an iconic object.

Signature

serialize_object(Object : : : SerializedItemHandle)

Description

serialize_objectserialize_objectSerializeObjectSerializeObjectSerializeObject serializes an iconic object (see fwrite_serialized_itemfwrite_serialized_itemFwriteSerializedItemFwriteSerializedItemFwriteSerializedItem 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 ObjectObjectObjectObjectobjectVal. The serialized iconic object is returned by the handle SerializedItemHandleSerializedItemHandleSerializedItemHandleSerializedItemHandleserializedItemHandle and can be deserialized by deserialize_objectdeserialize_objectDeserializeObjectDeserializeObjectDeserializeObject.

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

ObjectObjectObjectObjectobjectVal (input_object) object(-array) → object

Iconic object.

SerializedItemHandleSerializedItemHandleSerializedItemHandleSerializedItemHandleserializedItemHandle (output_control) serialized_item → (integer)

Handle of the serialized item.

Result

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

Possible Successors

fwrite_serialized_itemfwrite_serialized_itemFwriteSerializedItemFwriteSerializedItemFwriteSerializedItem, send_serialized_itemsend_serialized_itemSendSerializedItemSendSerializedItemSendSerializedItem, deserialize_objectdeserialize_objectDeserializeObjectDeserializeObjectDeserializeObject

Module

Foundation

Operators