.. _client_lib_script:

.. seealso::
  * :ref:`Работа с клиентскими библиотеками <client_lib>`
  * :pas:class:`TbtkScriptClientLibrary`

Библиотечные выборки
``````````````````````````````````````````````````````````````````````

.. pas:function:: IsLibLoaded(LibraryName: String): Boolean

  Проверяет, была ли библиотека загружена ранее.

  :param String LibraryName:
    Имя библиотеки. Состоит из '*Имя выборки'* или '*Имя выборки.Отображение'*.

  :rtype: Boolean

  .. code-block:: delphi
    :caption: Пример использования

    <Pascal>
      if not IsLibLoaded('SEL_Library') then
        ShowMessage('Библиотека SEL_Library не загружена.');
    </Pascal>

  .. warning:: |not_supported|

.. pas:function:: Libs(LibraryName: String): TbtkScriptClientLibrary

  Индексированное свойство, возвращающее ссылку на библиотеку по её имени.
  Если библиотека не была загружена ранее, будет произведена её загрузка.

  :param String LibraryName:
    Имя библиотеки. Состоит из '*Имя выборки'* или '*Имя выборки.Отображение'*.

  :rtype: TbtkScriptClientLibrary

  .. code-block:: delphi
    :caption: Пример использования

    <Pascal>
      res := Libs['SEL\_ClientLibraryInstance'].Execute('TestOperation', [1, 2, 3]);
    </Pascal>


.. pas:function:: LoadLib(LibraryName: String): TbtkScriptClientLibrary

  Загружает библиотеку в коллекцию библиотек. Если библиотека уже
  загружена, возвращает ссылку на ранее загруженную библиотеку.

  :param String LibraryName:
    Имя библиотеки. Состоит из '*Имя выборки*' или '*Имя выборки.Отображение*'.

  :rtype: TbtkScriptClientLibrary

  .. code-block:: delphi
    :caption: Пример использования

    <Pascal>
      lib := LoadLib('SEL_Library');
      lib := LoadLib('SEL_Library.MyRepresentation');
    </Pascal>

  .. warning:: |not_supported|


.. pas:function:: UnloadLib(LibraryName: String)

  Выгружает библиотеку из памяти, и метаданные из кэша.

  При выгрузке вызывается операция :btk:oper:`OnCloseFormQuery`, позволяющая предотвратить потерю несохраненных данных в открытых выборкой файлах.

  :param String LibraryName:
    Имя библиотеки. Состоит из '*Имя выборки*' или '*Имя выборки.Отображение*'.

  :param TbtkUnloadLibMode Mode:
    Необязательный параметр.

    Режим выдачи предупреждений.

    Значение по умолчанию: **ulForce**

  .. code-block:: delphi
    :caption: Пример использования

    <Pascal>
      UnloadLib('SEL_Library');
      UnloadLib('SEL_Library.MyRepresentation', ulDebug);
    </Pascal>

  .. seealso::
    :btk:oper:`OnCloseFormQuery`

.. pas:function:: UnloadAllLibs(Mode: TbtkUnloadLibMode)

  Выгружает все клиентские библиотеки из памяти, и их метаданные из кэша.

  :param TbtkUnloadLibMode Mode:
    Необязательный параметр.

    Режим выдачи предупреждений.

    Значение по умолчанию: :pas:class:`~TbtkUnloadLibMode.ulForce`.

  .. warning:: |not_supported|