.. highlightlang:: us

.. _matlab_save:

matlab_save
===========

.. index:: matlab_save

.. us.tag  matlab_save ENGLISH matlab New5100

:ref:`matlab_save` saves a UniScript object in a MATLAB file (mat file).

.. function::  err = matlab_save(obj, ssFileName)

.. us.return

**Return Value**

*err* is the number 0 if no error occurred or an error object 
(see :ref:`error_create`).
.. us.params

**Parameters**

.. uparam:: obj

   *obj* is a UniScript object.

.. uparam:: ssFileName

   *ssFileName* is the name of MATLAB file. MATLAB files normally carry the file
   extension :file:`.mat`.

.. us.example

**Example**

.. include:: ../include/test_matlab_save.ic

.. us.comment

**Comment**

*  Data will be saved in the MATLAB format version 5.

*  Byte order is little endian.

*  The data is saved compressed.

*  Strings are saved as UNICODE (utf-8).

* Variant matrices  (e. g. v = ["text", 123]) are not supported. They will
  be ignored without an error message.

.. us.history

**History**

.. list-table::
   :header-rows: 1

   * - Version
     - Description
   * - 5.10.0
     - New

.. seealso::
   :ref:`overview-matlab-files`,
   :ref:`matlab_load`,
   :ref:`import-of-matlab-data-files`

:sub:`id-765351`