---
title: "Функции"
type: guide
api: [api7]
tags: [guide, api7, lib]
sources:
  - lib_actx_fncts.html
---


## Функции

DisplayLibraryName - Получить имя библиотеки, отображаемое на экране
ExternalGetImage - Получить слайд для команды библиотеки с указанным номером
ExternalGetMenu - Получить меню библиотеки
ExternalGetResourceModule - Задать модуль с ресурсами библиотеки.
ExternalGetToolBarId - Задать идентификаторы панелей управления библиотеки
ExternalMenuItem - Получить строку меню для создания меню в виде строк
ExternalRunCommand - Головная функция библиотеки
GetHelpFile - Получить имя файла справочной системы, подключаемого к библиотеке
GetImageHeight - Задать высоту окна вывода слайда
GetImageWidth - Задать ширину окна вывода слайда
GetLibraryName - Получить имя библиотеки
IsOnApplication7 - Получить тип версии API используемого библиотекой.
LibInterfaceNotifyEntry - Головная функция библиотеки. Подписка на обработку событий


## Параметры библиотек типа Converter

IKompasConverter::VisualEditConvertParam
| Тип | Уровень | Имя параметра | Пример значения параметра | Обязательный | Описание |
| --- | --- | --- | --- | --- | --- |
| раздел | 0 | Convertors | | + | Список конверторов. |
| раздел | 1 | ConverType | LibConverter | + | Тип конвертора. |
| параметр строка | 2 | ProgID | "ProjectEDrawings.EDrawings" | ~1 | ProgID (Для ActiveX библиотек). |
| параметр строка | 2 | Path | "S:\C++\Visualc\MyConverter.rtw" | ~1 | Путь к файлу конвертора (Для обычных dll или rtw). |
| параметр строка | 2 | Name | "Пример конвертора" | + | Имя конвертора. |
| параметр DWORD | 2 | Connect | 1 | - | Признак подключения библиотеки: 1 - библиотека подключается (по необходимости), 0 - библиотека в openfile и savefile не используется. |
| раздел | 2 | FileType | m3d | + | Тип документа системы КОМПАС (расширение имени файла). |
| параметр строка | 3 | Filter | "Файлы моделей (*.mym3d)|*.mym3d|" | + | Фильтр для выбора файла. |
| параметр DWORD | 3 | OpenCommandID | 1 | ~2 | Номер команды для открытия файла. |
| параметр DWORD | 3 | SaveCommandID | 2 | ~2 | Номер команды для сохранения файла. |
| параметр DWORD | 3 | OpenConverterParameters | 1 | - | Признак наличия диалога редактирования параметров конвертации для заданной команды открытия файла. Если параметр задан, в диалоге выбора файла для открытия появится кнопка Параметры, которая позволяет открыть диалог параметров конвертора. Вызов диалога осуществляется функцией IKompasConverter::VisualEditConvertParam. |
| параметр DWORD | 3 | SaveConverterParameters | 1 | - | Признак наличия диалога редактирования параметров конвертации для заданной команды сохранения файла. Если параметр задан, в диалоге выбора файла для открытия появится кнопка Параметры, которая позволяет открыть диалог параметров конвертора. Вызов диалога осуществляется функцией |
Значения параметра Обязательный:
+ - обязательный параметр;
- - необязательный параметр;
~1 - обязательно нужен один из параметров или ProgID или Path. Одновременно оба ключа задавать не нужно, первым проверяется наличие ключа ProgID.
~2 - OpenCommandID и SaveCommandID не являются обязательными, но нужен хотя бы один ключ. Можно задать оба ключа.


## Функции оформления библиотек

DisplayLibraryName - Получить имя библиотеки
DisplayLibraryNameW - Получить имя библиотеки (Unicode)
LibInterfaceNotifyEntry - Головная функция библиотеки, подписка на обработку событий
LibIsOnApplication7 - Задать тип версии API, используемого библиотекой
LibObjInterfaceEntry - Получить имя библиотеки (Unicode)
LibraryBmpBeginID - Получить для указанного размера иконок начало диапазона идентификаторов иконок команд библиотеки
LIBRARYBMPSIZE - Задать размер окна вывода растрового слайда
LIBRARYENTRYDEMOEX - Головная функция библиотеки (демо режим)
LIBRARYENTRYDEMO - Головная функция библиотеки (демо режим)
LIBRARYENTRY - Головная функция библиотеки
LIBRARYHELPFILE - Определить имя файла справочной системы, подключаемого к библиотеке
LIBRARYHELPFILEW - Определить имя файла справочной системы, подключаемого к библиотеке (Unicode)
LibraryHintTipsBeginID - Задать идентификатор начала диапазона ресурсов для подсказок к командам
LIBRARYID - Задать идентификатор ресурсов
LIBRARYNAME - Задать имя библиотеки
LIBRARYNAMEW - Задать имя библиотеки (Unicode)
LibToolBarId - Получить идентификаторы инструментальных и компактных панелей


## Функции работы с макроэлементами и библиотечными макроэлементами

Библиотечный макроэлемент - это макроэлемент, имеющий пользовательские параметры.
Пользовательские параметры могут быть записаны в макроэлемент при помощи функции ksSetMacroParam.
Также при помощи функции ksSetMacroParam может быть включен режим управления характерными точками макроэлемента (поддержка макроэлементом интерфейса ILibHPObject ), отработка событий внешних воздействий на макроэлемент (поддержка макроэлементом интерфейса ILibExternalObject), выключен\включен режим редактирования макроэлемента по двойному щелчку мыши.
Получить пользовательские параметры можно при помощи функции GetMacroParam.
EditMacroMode - Получить режим работы функции библиотеки (создание нового или редактирование существующего макроэлемента)
GetMacroParam - Получить параметры макроэлемента
GetMacroParamSize - Получить размер памяти параметров указанного макроэлемента
GetMacroPlacement - Получить точку привязки и угол поворота макроэлемента
ksAddObjectToMacro - Добавить объект, слой, вид или группу объектов в макроэлемент
ksGetMacroEditParam - Получить параметры редактирования указанного макроэлемента
ksGetMacroEditParamW - Получить параметры редактирования указанного макроэлемента (Unicode)
ksGetMacroPlacement - Получить точку привязки и угол поворота макроэлемента
ksGetMacroPlacementEx - Получить точку привязки и угол поворота макроэлемента
ksGetMacroWaitDblClickEdit - Получить режим ожидания DblClick при редактировании макроэлемента
ksOpenMacro - Открыть макроэлемент для редактирования
ksSetMacroParam - Записать параметры макроэлемента
ksSetMacroParamW - Записать параметры макроэлемента (Unicode)
ksSetMacroPlacementEx - Установить точку привязки и угол поворота макроэлемента
ksSetMacroWaitDblClickEdit - Изменить режим ожидания DblClick при редактировании макроэлемента
ksUpdateMacro - Очистить макроэлемент и положить в него группу
Macro - Создать новый макроэлемент
SetMacroParam - Установить параметры макроэлемента
SetMacroPlacement - Установить точку привязки и угол поворота макроэлемента
