Skip to content

serialize_objectSerializeObjectSerializeObjectserialize_objectT_serialize_object🔗

Short description🔗

serialize_objectSerializeObjectSerializeObjectserialize_objectT_serialize_object — Serialize an iconic object.

Signature🔗

serialize_object( object Object, out serialized_item SerializedItemHandle )void SerializeObject( const HObject& Object, HTuple* SerializedItemHandle )static void HOperatorSet.SerializeObject( HObject objectVal, out HTuple serializedItemHandle )def serialize_object( object: HObject ) -> HHandle

Herror T_serialize_object( const Hobject Object, Htuple* SerializedItemHandle )

HSerializedItem HObject::SerializeObject( ) const

HSerializedItem HObject.SerializeObject( )

Description🔗

serialize_objectSerializeObject serializes an iconic object (see fwrite_serialized_itemFwriteSerializedItem 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 ObjectobjectValobject. The serialized iconic object is returned by the handle SerializedItemHandleserializedItemHandleserialized_item_handle and can be deserialized by deserialize_objectDeserializeObject.

Execution information🔗

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🔗

ObjectobjectValobject (input_object) object(-array) → objectHObjectHObjectHObjectHobject

Iconic object.

SerializedItemHandleserializedItemHandleserialized_item_handle (output_control) serialized_item → (handle)HTuple (HHandle)HSerializedItem, HTuple (IntPtr)HHandleHtuple (handle)

Handle of the serialized item.

Result🔗

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

Combinations with other operators🔗

Combinations

Possible successors

fwrite_serialized_itemFwriteSerializedItem, send_serialized_itemSendSerializedItem, deserialize_objectDeserializeObject

See also

deserialize_objectDeserializeObject

Module🔗

Foundation