.. highlightlang:: us

.. index:: loadiclib

.. _loadiclib:

loadiclib
=========

.. us.tag  loadiclib ENGLISH Programming.Symboltable Changed500 Changed5200 Changed5300

:ref:`loadiclib` loads a UniScript library which contains UniScript functions in
binary form.

.. function::  bool = loadiclib(ssFileName)

.. us.return

**Return Value**

*bool* is TRUE (1) when the file *ssFileName* can be read, and FALSE (0) if
it cannot.

.. us.params

**Parameters**

.. uparam:: ssFileName

   *ssFileName* is the name of the UniScript library. UniScript libraries normally
   carry the file extension :file:`.icl`.

.. us.comment

**Comment**

The default library has the name :file:`uniplot\program\rs_sl.icl`. The library
will be loaded at startup time. If one of the ic files in the directory
:file:`uniplot\script` has been altered the library should be rebuild
(:ref:`toolscreate-uniscript-library`).

A UniScript library (``.icl``) can have one function with the name LibMain. 
This function will be called directly after loading the library.

.. us.history

**History**

.. list-table::
   :header-rows: 1
   
   * - Version
     - Description
   * - 5.30
     - UniPlot 5.30 saves UniScript-Librarys in a new format (Format version 8),
       that older UniPlot version cannot load. UniPlot 5.30 cannot read
       libraries version 1-7.
   * - 5.20
     - UniPlot 5.20 saves UniScript-Librarys in a new format (Format version 7),
       that older UniPlot version cannot load. UniPlot 5.20 cannot read
       libraries version 1-6.

       Librarys of UniPlot 5.20 and higher are compatible between the 32-bit and
       the 64-bit UniPlot version.
   * - 5.0.0
     - UniScript 5.x-Librarys are not compatible with UniScript 4.x libraries.
       UniScript 5.x can read UniScript 4.x icl files.

.. seealso::
   :ref:`overview-programming`,
   :ref:`saveiclib`,
   :ref:`load`,
   :ref:`loadlib`,
   :ref:`LibMain`,
   :ref:`clear`

:sub:`id-837580`