deserialize_matrixT_deserialize_matrixDeserializeMatrixDeserializeMatrix (Operator)

Name

deserialize_matrixT_deserialize_matrixDeserializeMatrixDeserializeMatrix — Deserialize a serialized matrix.

Signature

deserialize_matrix( : : SerializedItemHandle : MatrixID)

Herror T_deserialize_matrix(const Htuple SerializedItemHandle, Htuple* MatrixID)

void DeserializeMatrix(const HTuple& SerializedItemHandle, HTuple* MatrixID)

void HMatrix::DeserializeMatrix(const HSerializedItem& SerializedItemHandle)

static void HOperatorSet.DeserializeMatrix(HTuple serializedItemHandle, out HTuple matrixID)

void HMatrix.DeserializeMatrix(HSerializedItem serializedItemHandle)

Description

deserialize_matrixdeserialize_matrixDeserializeMatrixDeserializeMatrixDeserializeMatrix deserializes a matrix, that was serialized by serialize_matrixserialize_matrixSerializeMatrixSerializeMatrixSerializeMatrix (see fwrite_serialized_itemfwrite_serialized_itemFwriteSerializedItemFwriteSerializedItemFwriteSerializedItem for an introduction of the basic principle of serialization). The serialized matrix is defined by the handle SerializedItemHandleSerializedItemHandleSerializedItemHandleSerializedItemHandleserializedItemHandle. The deserialized values are stored in an automatically created matrix with the handle MatrixIDMatrixIDMatrixIDMatrixIDmatrixID. Access to the elements of the matrix is possible e.g. with the operator get_full_matrixget_full_matrixGetFullMatrixGetFullMatrixGetFullMatrix.

Execution Information

Parameters

SerializedItemHandleSerializedItemHandleSerializedItemHandleSerializedItemHandleserializedItemHandle (input_control)  serialized_item HSerializedItem, HTupleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handle of the serialized item.

MatrixIDMatrixIDMatrixIDMatrixIDmatrixID (output_control)  matrix HMatrix, HTupleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Matrix handle.

Result

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

Possible Predecessors

fread_serialized_itemfread_serialized_itemFreadSerializedItemFreadSerializedItemFreadSerializedItem, receive_serialized_itemreceive_serialized_itemReceiveSerializedItemReceiveSerializedItemReceiveSerializedItem, serialize_matrixserialize_matrixSerializeMatrixSerializeMatrixSerializeMatrix

Possible Successors

get_full_matrixget_full_matrixGetFullMatrixGetFullMatrixGetFullMatrix

Module

Foundation