Operator Reference
serialize_object (Operator)
serialize_object
— Serialize an iconic object.
Signature
serialize_object(Object : : : SerializedItemHandle)
Description
serialize_object
serializes an iconic object (see
fwrite_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
Object
. The serialized iconic object is returned by the handle
SerializedItemHandle
and can be deserialized by
deserialize_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
Object
(input_object) object(-array) →
object
Iconic object.
SerializedItemHandle
(output_control) serialized_item →
(handle)
Handle of the serialized item.
Result
If the parameters are valid, the operator
serialize_object
returns the value 2 (
H_MSG_TRUE)
. If
necessary, an exception is raised.
Possible Successors
fwrite_serialized_item
,
send_serialized_item
,
deserialize_object
See also
Module
Foundation