serialize_handle🔗
Short description🔗
serialize_handle — Serialize the content of a handle.
Signature🔗
serialize_handle( handle Handle, out serialized_item SerializedItem )
Description🔗
serialize_handle serializes the content of Handle and
returns the serialized item in SerializedItem
(see fwrite_serialized_item for an introduction of the basic
principle of serialization).
The serialized item can later be deserialized with
deserialize_handle.
Note that not all handle types support serialization.
To check if a handle can be serializes, use tuple_is_serializable
or tuple_is_serializable_elem.
Handles that have already been cleared cannot be serialized.
Also note that the serialized item created by this operator is compatible
with the type specific deserialization operators, such as
deserialize_matrix or deserialize_shape_model.
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🔗
Handle (input_control) handle → (handle)
Handle that should be serialized.
SerializedItem (output_control) serialized_item → (handle)
Handle containing the serialized item.
Example🔗
(HDevelop)
create_matrix (3, 3, 0, MatrixID)
serialize_handle (MatrixID, SerializedMatrix)
deserialize_handle (SerializedMatrix, MatrixID2)
Result🔗
If the parameters are valid, the operator serialize_handle
returns the value 2 (H_MSG_TRUE). Otherwise, an exception is raised.
Combinations with other operators🔗
Combinations
Possible predecessors
tuple_is_serializable, tuple_is_serializable_elem
Possible successors
deserialize_handle, fwrite_serialized_item, send_serialized_item
Module🔗
Foundation