---
title: "Интерфейс IInsertsLibrary"
type: interface
api: [api7]
tags: [interface, api7, iinsertslibrary]
sources:
  - iinsertslibrary.html
---

*API интерфейсов. Версия 7 > Менеджер библиотек  > Интерфейс ILibrary  > ILibrary - методы *


## Интерфейс IInsertsLibrary

Интерфейс библиотеки элементов (документов) Компас.
Иерархия:
IKompasAPIObject
ILibrary
IInsertsLibrary
Описание:
Позволяет получить доступ к библиотеке элементов (документов) системы КОМПАС (фрагментов или моделей), редактировать структуру библиотеки, получить доступ к коллекции элементов (документов) библиотеки.
Примечание:
Интерфейс библиотеки фрагментов или моделей системы КОМПАС можно получить у интерфейса IInsertsLibraries с помощью свойства IInsertsLibraries::Item.


## ActiveFolder - Активная папка в окне библиотеки элементов

Функция не поддерживается
Тип данных: BSTR (строка)
Синтаксис Automation:
```
ActiveFolder = iObject.ActiveFolder    Получить свойство (* )
ActiveFolder = iObject.GetActiveFolder    Получить свойство (**)
```
Синтаксис COM:
```
iObject->get_ActiveFolder (&ActiveFolder)    Получить свойство
```
Примечание:
Свойство позволяет получить активную папку в окне библиотеки.


## AddFolder - Добавить папку в библиотеку элементов

Функция не поддерживается
Синтаксис Automation:
```
BOOL AddFolder (BSTR PathFolder);
```
Синтаксис COM:
```
HRESULT AddFolder ([in] BSTR PathFolder, [out, retval] VARIANT_BOOL* pVal);
Входные параметры:
PathFolder    - путь к папке,
post    - TRUE - отложенное выполнение.
Возвращаемое значение:
TRUE    - в случае успеха,
FALSE    - в случае неудачи.
```
Примечание:
Добавляет новую папку в библиотеку элементов.


## Delete - Удалить описание библиотеки

Синтаксис Automation:
```
BOOL Delete();
```
Синтаксис COM:
```
HRESULT Delete( BOOL* Result );
Возвращаемое значение:
TRUE    - в случае успеха,
FALSE    - в случае неудачи.
```


## Inserts - Коллекция элементов (документов) библиотеки

Тип данных: указатель на интерфейс IInserts
Синтаксис Automation:
```
Inserts = iObject.Inserts    Получить свойство (* )
Inserts = iObject.GetInserts    Получить свойство (**)
```
Синтаксис COM:
```
iObject->get_Inserts (&Inserts)    Получить свойство
```
Примечание:
Свойство позволяет получить коллекцию элементов (документов) библиотеки.


## IsDocumentExist - Функция проверяет существование документа с именем в библиотеке документов

Синтаксис Automation:
```
BOOL IsDocumentExist( BSTR DocumentPath );
```
Синтаксис COM:
```
HRESULT IsDocumentExist( BSTR DocumentPath, BOOL * Result );
Входные параметры:
DocumentPath    - путь к документу внутри библиотеки документов.
КOMPAS v24
```


## IsPredefinedTextLibrary - Использовать библиотеку для вставки типовых текстов

Тип данных: BOOL
Синтаксис Automation:
```
IsPredefinedTextLibrary = Object.IsPredefinedTextLibrary    Получить свойство (* )
Object.IsPredefinedTextLibrary = IsPredefinedTextLibrary    Установить свойство (* )
IsPredefinedTextLibrary = Object.GetIsPredefinedTextLibrary()    Получить свойство (**)
Object.SetIsPredefinedTextLibrary( IsPredefinedTextLibrary )    Установить свойство (**)
```
Синтаксис COM:
```
Object.get_IsPredefinedTextLibrary( &IsPredefinedTextLibrary )    Получить свойство
Object.put_IsPredefinedTextLibrary( IsPredefinedTextLibrary )    Установить свойство
КOMPAS v24
```


## RemoveFolder - Удалить папку из библиотеки элементов

Функция не поддерживается
Синтаксис Automation:
```
BOOL RemoveFolder (BSTR PathFolder);
```
Синтаксис COM:
```
HRESULT RemoveFolder ([in] BSTR PathFolder, [out, retval] VARIANT_BOOL* pVal);
Входные параметры:
PathFolder    - путь к папке,
post    - TRUE - отложенное выполнение.
Возвращаемое значение:
TRUE    - в случае успеха,
FALSE    - в случае неудачи.
```
Примечание:
Удаляет папку из библиотеки элементов.


## SetActiveFolder - Установить активную папку в окне библиотеки элементов (документов)

Функция не поддерживается
Синтаксис Automation:
```
BOOL SetActiveFolder (BSTR PathFolder, BOOL LastIsFile, BOOL HaveLibName);
```
Синтаксис COM:
```
HRESULT SetActiveFolder ([in] BSTR PathFolder,
VARIANT_BOOL LastIsFile,
VARIANT_BOOL HaveLibName,
[out, retval] VARIANT_BOOL * pVal);
Входные параметры:
PathFolder    - путь к папке,
LastIsFile    TRUE - в пути имеется имя файла документа,
HaveLibName(BOOL)    - TRUE - в пути имеется имя библиотеки.
Возвращаемое значение:
TRUE    - в случае успеха,
FALSE    - в случае неудачи.
```
Примечание:
Метод позволяет установить активную папку в окне библиотеки документов. Путь к папке может содержать или не содержать имя библиотеки и имя документа. Имя библиотеки, имя папки и имя документа разделяются символом "|". Если папка является вложенной, т. е. находится внутри другой папки, названия папок в пути отделяются символом "|".
Пример. Библиотека с именем 111, содержит папку с именем ddd, в которой находится файл с именем fragment. Путь к этому файлу должен быть задан следующим образом: 111|ddd|fragment.
