Operator Reference
serialize_matrix (Operator)
serialize_matrix
— Serialize a matrix.
Signature
serialize_matrix( : : MatrixID : SerializedItemHandle)
Description
serialize_matrix
serializes the data of a matrix (see
fwrite_serialized_item
for an introduction of the basic
principle of serialization). The same data that is written in a
file by write_matrix
is converted to a serialized item.
The matrix is defined by the handle MatrixID
. The
serialized matrix is returned by the handle
SerializedItemHandle
and can be deserialized by
deserialize_matrix
.
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
MatrixID
(input_control) matrix →
(handle)
Matrix handle.
SerializedItemHandle
(output_control) serialized_item →
(handle)
Handle of the serialized item.
Result
If the parameters are valid, the operator
serialize_matrix
returns the value 2 (
H_MSG_TRUE)
. If
necessary, an exception is raised.
Possible Predecessors
Possible Successors
fwrite_serialized_item
,
send_serialized_item
,
deserialize_matrix
Module
Foundation