Skip to content

serialize_tupleSerializeTupleSerializeTupleserialize_tupleT_serialize_tuple🔗

Short description🔗

serialize_tupleSerializeTupleSerializeTupleserialize_tupleT_serialize_tuple — Serialize a tuple.

Signature🔗

serialize_tuple( tuple Tuple, out serialized_item SerializedItemHandle )void SerializeTuple( const HTuple& Tuple, HTuple* SerializedItemHandle )static void HOperatorSet.SerializeTuple( HTuple tuple, out HTuple serializedItemHandle )def serialize_tuple( tuple: HTupleType ) -> HHandle

Herror T_serialize_tuple( const Htuple Tuple, Htuple* SerializedItemHandle )

HSerializedItem HTuple::SerializeTuple( ) const

HSerializedItem HTuple.SerializeTuple( )

Description🔗

serialize_tupleSerializeTuple serializes the data of a tuple (see fwrite_serialized_itemFwriteSerializedItem for an introduction of the basic principle of serialization). The same data that is written in a file by write_tupleWriteTuple is converted to a serialized item. The tuple is defined by the handle Tupletupletuple. The serialized data of a tuple is returned by the handle SerializedItemHandleserializedItemHandleserialized_item_handle and can be deserialized by deserialize_tupleDeserializeTuple.

Note that not all handle types can be serialized. If Tupletupletuple contains a handle that can not be serialized or that has been freed already, an exception is raised. The operators tuple_is_serializableTupleIsSerializable and tuple_is_serializable_elemTupleIsSerializableElem can be used to find out if a tuple or its elements can be serialized.

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🔗

Tupletupletuple (input_control) tuple(-array) → (real / integer / string / handle)HTuple (double / Hlong / HString / HHandle)HTuple (double / int / long / string / HHandle)HTupleTypeHtuple (double / Hlong / char* / handle)

Tuple.

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_tupleSerializeTuple 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_tupleDeserializeTuple

Module🔗

Foundation