---
title: "Менеджер лицензий"
type: interface
api: [api7]
tags: [interface, api7, ap1981077]
sources:
  - ap1981077.html
  - iapplicationlicensemanager.html
  - iplmobject.html
  - iplmobjectsmanager.html
---

*API интерфейсов. Версия 7 > Приложение*




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

Менеджер лицензий
Иерархия:
IDispatch
IApplicationLicenseManager
Примечание:
Интерфейс является дополнительным к интерфейсу приложения IApplication. Интерфейс можно получить посредством вызова метода IUnknown::QueryInterface (const GUID far& iid, void** pif).
Версия: Компас v19


## EnableKompasInvisible - Установить ключ для КОМПАС- Invisible

Синтаксис Automation:
```
BOOL EnableKompasInvisible( BSTR Key, BSTR Signature );
```
Синтаксис COM:
```
HRESULT EnableKompasInvisible( BSTR Key, BSTR Signature, BOOL * Result );
Возвращаемое значение:
TRUE    - в случае удачного завершения.
Входные параметры:
Key    - имя (передается из внешнего приложения),
Signature    - лицензия для проверки подлинности (передается из внешнего приложения).
```


## KompasModuleActive - Доступность компонентов КОМПАС

Тип данных: BOOL
Синтаксис Automation:
```
KompasModuleActive = Object.KompasModuleActive( Module )    Получить свойство (* )
Object.KompasModuleActive( Module ) = KompasModuleActive    Установить свойство (* )
KompasModuleActive = Object.GetKompasModuleActive( Module )    Получить свойство (**)
Object.SetKompasModuleActive( Module, KompasModuleActive )    Установить свойство (* )
```
Синтаксис COM:
```
Object.get_KompasModuleActive( Module, &KompasModuleActive )    Получить свойство
Object.put_KompasModuleActive( Module, KompasModuleActive )    Установить свойство
Входные параметры:
ksKompasModuleEnum    - Module - Модули Компас.
```


## KompasVariant - Получение типа установленного дистрибутива в виде комбинации флаговиз ksKompasVariantEnum

Тип данных: long
Синтаксис Automation:
```
KompasVariant = Object.KompasVariant    Получить свойство (* )
KompasVariant = Object.GetKompasVariant()    Получить свойство (**)
```
Синтаксис COM:
```
Object.get_KompasVariant( &KompasVariant )    Получить свойство (* )
```
Примечание:
Свойство доступно только для чтения.
См. также ksKompasVariantEnum


## LibraryActive - Доступность продукта по номеру

Тип данных: BOOL
Синтаксис Automation:
```
LibraryActive = Object.LibraryActive( ProductNumber )    Получить свойство (* )
Object.LibraryActive( ProductNumber ) = LibraryActive    Установить свойство (* )
LibraryActive = Object.GetLibraryActive( ProductNumber )    Получить свойство (**)
Object.SetLibraryActive( ProductNumber, LibraryActive )    Установить свойство (* )
```
Синтаксис COM:
```
Object.get_LibraryActive( ProductNumber, &LibraryActive )    Получить свойство
Object.put_LibraryActive( ProductNumber, LibraryActive )    Установить свойство
Входные параметры:
long ProductNumber    - номер продукта.
```


## LibraryLocalStatus - Признак локальный/сетевой продукт

Тип данных: BOOL
Синтаксис Automation:
```
LibraryLocalStatus = Object.LibraryLocalStatus( ProductNumber )    Получить свойство (* )
LibraryLocalStatus = Object.GetLibraryLocalStatus( ProductNumber )    Получить свойство (**)
```
Синтаксис COM:
```
Object.get_LibraryLocalStatus( ProductNumber, &LibraryLocalStatus )    Получить свойство (* )
Входные параметры:
long ProductNumber    - номер продукта.
```
Примечание:
Свойство доступно только для чтения.


## LibraryProductKeyInfo - Информация о текущей сессии

Тип данных: BSTR
Синтаксис Automation:
```
LibraryProductKeyInfo = Object.LibraryProductKeyInfo(ProductNumber)    Получить свойство (* )
LibraryProductKeyInfo = Object.GetLibraryProductKeyInfo(ProductNumber)    Получить свойство (**)
```
Синтаксис COM:
```
Object.get_LibraryProductKeyInfo(ProductNumber, &LibraryProductKeyInfo )    Получить свойство (* )
Входные параметры:
long ProductNumber    - номер продукта.
```
Примечание:
Свойство доступно только для чтения.


## LibraryProductName - Получить название продукта

Тип данных: BSTR
Синтаксис Automation:
```
LibraryProductName = Object.LibraryProductName( ProductNumber )    Получить свойство (* )
LibraryProductName = Object.GetLibraryProductName( ProductNumber )    Получить свойство (**)
```
Синтаксис COM:
```
Object.get_LibraryProductName( ProductNumber, &LibraryProductName )    Получить свойство (* )
Входные параметры:
long ProductNumber    - номер продукта.
```
Примечание:
Свойство доступно только для чтения.


## LibraryStatus - Получить текущий статус продукта по номеру

Тип данных: из перечисления ksProtectProductStatusEnum.
Синтаксис Automation:
```
LibraryStatus = Object.LibraryStatus( ProductNumber )    Получить свойство (* )
LibraryStatus = Object.GetLibraryStatus( ProductNumber )    Получить свойство (**)
```
Синтаксис COM:
```
Object.get_LibraryStatus( ProductNumber, &LibraryStatus )    Получить свойство (* )
Входные параметры:
long ProductNumber    - номер продукта.
```
Примечание:
Свойство доступно только для чтения.


## LibraryTrialStatus - Ознакомительный период

Тип данных: BOOL
Синтаксис Automation:
```
LibraryTrialStatus = Object.LibraryTrialStatus( ProductNumber )    Получить свойство (* )
LibraryTrialStatus = Object.GetLibraryTrialStatus( ProductNumber )    Получить свойство (**)
```
Синтаксис COM:
```
Object.get_LibraryTrialStatus( ProductNumber, &LibraryTrialStatus )    Получить свойство (* )
```
Примечание:
Свойство доступно только для чтения.


## RegisterLibraryNumber - Зарегистрировать номер продукта на сервере лицензий Компас

Синтаксис Automation:
```
long RegisterLibraryNumber( long ProductNumber );
```
Синтаксис COM:
```
HRESULT RegisterLibraryNumber( long ProductNumber, long * ProductNumbUnicueId );
Возвращаемое значение:
- Уникальный идентификатор продукта.
Входные параметры:
long ProductNumber    - номер продукта.
```
Примечание
Уникальный идентификатор продукта используется для разрегистрации продукта функцией IApplicationLicenseManager::UnRegisterLibraryNumber.


## UnRegisterLibraryNumber - Разрегистрировать номер продукта на сервере лицензий Компас

Синтаксис Automation:
```
long UnRegisterLibraryNumber( long ProductNumbUnicueId );
```
Синтаксис COM:
```
HRESULT UnRegisterLibraryNumber( long ProductNumbUnicueId, BOOL * Result );
Возвращаемое значение:
TRUE    - в случае удачного завершения.
Входные параметры:
long ProductNumber    - номер продукта.
```


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

Интерфейс объекта системы версионирования.
Иерархия:
IDispatch
IPLMObject
Версия KOMPAS v19


## PLMChange - Отличие в системе версионирования

Тип данных: из перечисления ksPLMChangesEnum.
Синтаксис Automation:
```
PLMChange = Object.PLMChange    Получить свойство (* )
Object.PLMChange = PLMChange    Установить свойство (* )
PLMChange = Object.GetPLMChange()    Получить свойство (**)
Object.SetPLMChange( PLMChange )    Установить свойство (* )
```
Синтаксис COM:
```
Object.get_PLMChange( &PLMChange )    Получить свойство
Object.put_PLMChange( PLMChange )    Установить свойство
```


## PLMComposition - Состояние состава объекта

Тип данных: из перечисления ksPLMCompositionEnum
Синтаксис Automation:
```
PLMComposition = Object.PLMComposition    Получить свойство (* )
Object.PLMComposition = PLMComposition    Установить свойство (* )
PLMComposition = Object.GetPLMComposition()    Получить свойство (**)
Object.SetPLMComposition( PLMComposition )    Установить свойство (* )
```
Синтаксис COM:
```
Object.get_PLMComposition( &PLMComposition )    Получить свойство
Object.put_PLMComposition( PLMComposition )    Установить свойство
Версия Компас v23
```


## PLMPropertyValue - Значение свойств в системе версионирования

Тип данных: VARIANT
Синтаксис Automation:
```
PLMPropertyValue = Object.PLMPropertyValue( Property )    Получить свойство (* )
Object.PLMPropertyValue( Property ) = PLMPropertyValue    Установить свойство (* )
PLMPropertyValue = Object.GetPLMPropertyValue( Property )    Получить свойство (**)
Object.SetPLMPropertyValue( Property, PLMPropertyValue )    Установить свойство (* )
```
Синтаксис COM:
```
Object.get_PLMPropertyValue( Property, &PLMPropertyValue )    Получить свойство
Object.put_PLMPropertyValue( Property, PLMPropertyValue )    Установить свойство
Входные параметры:
Property    - тип свойства из перечисления ksPLMPropertyEnum.
Версия Компас v21
```


## PLMStatus - Статус в системе версионирования

Тип данных: из перечисления ksPLMStatusEnum
Синтаксис Automation:
```
PLMStatus = Object.PLMStatus    Получить свойство (* )
Object.PLMStatus = PLMStatus    Установить свойство (* )
PLMStatus = Object.GetPLMStatus()    Получить свойство (**)
Object.SetPLMStatus( PLMStatus )    Установить свойство (* )
```
Синтаксис COM:
```
Object.get_PLMStatus( &PLMStatus )    Получить свойство
Object.put_PLMStatus( PLMStatus )    Установить свойство
```


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

Менеджер объектов системы версионирования.
Иерархия:
IDispatch
IPLMObjectsManager
Версия KOMPAS v19


## PLMChange - Отличие в системе версионирования

Тип данных: из перечисления ksPLMChangesEnum.
Синтаксис Automation:
```
PLMChange = Object.PLMChange( FileName )    Получить свойство (* )
Object.PLMChange( FileName ) = PLMChange    Установить свойство (* )
PLMChange = Object.GetPLMChange( FileName )    Получить свойство (**)
Object.SetPLMChange( FileName, PLMChange )    Установить свойство (* )
```
Синтаксис COM:
```
Object.get_PLMChange( FileName, &PLMChange )    Получить свойство
Object.put_PLMChange( FileName, PLMChange )    Установить свойство
Входные параметры:
BSTR    - FileName - имя файла.
```
Примечание
Свойство позволяет получить/установить признак отличия объектов версионирования по имени файла.


## PLMComposition - Состояние состава в системе версионирования

Тип данных: из перечисления ksPLMCompositionEnum
Синтаксис Automation:
```
PLMComposition = Object.PLMComposition( FileName )    Получить свойство (* )
Object.PLMComposition( FileName ) = PLMComposition    Установить свойство (* )
PLMComposition = Object.GetPLMComposition( FileName )    Получить свойство (**)
Object.SetPLMComposition( FileName, PLMComposition )    Установить свойство (* )
```
Синтаксис COM:
```
Object.get_PLMComposition( FileName, &PLMComposition )    Получить свойство
Object.put_PLMComposition( FileName, PLMComposition )    Установить свойство
Входные параметры:
BSTR FileName    - имя файла.
```
Примечание:
Свойство позволяет получить/установить состояние состава объектов в системе версионирования по имени файла.
Версия Компас v23


## PLMPropertyValue - Значение свойств в системе версионирования

Тип данных: VARIANT
Синтаксис Automation:
```
PLMPropertyValue = Object.PLMPropertyValue( Property, FileName )    Получить свойство (* )
Object.PLMPropertyValue( Property, FileName ) = PLMPropertyValue    Установить свойство (* )
PLMPropertyValue = Object.GetPLMPropertyValue( Property, FileName )    Получить свойство (**)
Object.SetPLMPropertyValue( Property, FileName, PLMPropertyValue )    Установить свойство (* )
```
Синтаксис COM:
```
Object.get_PLMPropertyValue( Property, FileName, &PLMPropertyValue )    Получить свойство
Object.put_PLMPropertyValue( Property, FileName, PLMPropertyValue )    Установить свойство
Входные параметры:
Property    - тип свойства из перечисления ksPLMPropertyEnum,
FileName    - путь к файлу.
Версия Компас v21
```


## PLMStatus - Статус в системе версионирования

Тип данных: из перечисления ksPLMStatusEnum.
Синтаксис Automation:
```
PLMStatus = Object.PLMStatus( FileName )    Получить свойство (* )
Object.PLMStatus( FileName ) = PLMStatus    Установить свойство (* )
PLMStatus = Object.GetPLMStatus( FileName )    Получить свойство (**)
Object.SetPLMStatus( FileName, PLMStatus )    Установить свойство (* )
```
Синтаксис COM:
```
Object.get_PLMStatus( FileName, &PLMStatus )    Получить свойство
Object.put_PLMStatus( FileName, PLMStatus )    Установить свойство
Входные параметры:
BSTR    - FileName - имя файла.
```
Примечание:
Свойство позволяет получить/установить статус объектов версионирования по имени файла.


## SetPLMChangesAttrAvailability - Установить доступность в настройках Дерева документа пункта меню “ЛОЦМАН Отличия”

Синтаксис Automation:
```
BOOL SetPLMChangesAttrAvailability( BOOL Available, BOOL Enabled );
Синтаксис COM :
HRESULT SetPLMChangesAttrAvailability( BOOL Available, BOOL Enabled, BOOL * Result );
Возвращаемое значение:
TRUE    - в случае удачного завершения.
Входные параметры:
Available    - доступность атрибута “ЛОЦМАН Отличия” в контекстном меню настроек Дерева документа,
Enabled    - видимость в атрибутов “ЛОЦМАН Отличия” в Дереве.
```


## SetPLMCompositionsAttrAvailability - Установить доступность в настройках дерева документа пункта меню 'ЛОЦМАН Состав'.

Синтаксис Automation:
```
BOOL SetPLMCompositionsAttrAvailability( BOOL Available, BOOL Enabled );
```
Синтаксис COM:
```
HRESULT SetPLMCompositionsAttrAvailability( BOOL Available, BOOL Enabled, BOOL * Result );
Возвращаемое значение:
TRUE    - в случае удачного завершения.
Входные параметры:
Available    - доступность атрибута “ЛОЦМАН Состав” в контекстном меню настроек Дерева документа,
Enabled    - видимость атрибутов “ЛОЦМАН Состав” в Дереве.
Версия Компас v23
```


## SetPLMPropertyAvailability - Управление отображением свойств Лоцман в окне “Параметры”

Синтаксис Automation:
```
BOOL SetPLMPropertyAvailability( ksPLMPropertyEnum Property, BOOL Available, BOOL Enabled, VARIANT ValueList );
```
Синтаксис COM:
```
HRESULT SetPLMPropertyAvailability( ksPLMPropertyEnum Property, BOOL Available, BOOL Enabled, VARIANT ValueList, BOOL * Result );
Возвращаемое значение:
TRUE    - в случае успешного завершения,
FALSE    - в случае неудачи.
Выходные параметры:
Property    - тип свойства из перечисления ksPLMPropertyEnum,
Available    - включить отображение свойства,
Enabled    - включить доступность изменения значения,
ValueList    - список значений.
Версия Компас v21
```


## SetPLMStatusAttrAvailability - Установить доступность в настройках Дерева документа пункта меню “ЛОЦМАН Статус”

Синтаксис Automation:
```
BOOL SetPLMStatusAttrAvailability( BOOL Available, BOOL Enabled );
```
Синтаксис COM:
```
HRESULT SetPLMStatusAttrAvailability( BOOL Available, BOOL Enabled, BOOL * Result );
Возвращаемое значение:
TRUE    - в случае удачного завершения.
Входные параметры:
Available    - доступность атрибута “ЛОЦМАН Статус” в контекстном меню настроек Дерева документа,
Enabled    - видимость атрибутов “ЛОЦМАН Статус” в Дереве.
```
