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

*API интерфейсов. Версия 7 > Приложение > Информация об ошибках *


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

Интерфейс информации об ошибке системы КОМПАС.
Иерархия:
IKompasAPIObject
IKompasError
Описание:
1. Позволяет получить информацию об ошибке, возникшей при работе API системы КОМПАС.
2. Системные ошибки описаны двумя перечислениями: Ошибки API ErrorType и Ошибки 3D API ErrorType3d
В случае возникновения фатальных ошибок большинство методов интерфейсов и экспортных функций API КОМПАС выполняться не будут.
Если в результате работы библиотеки возникает ошибка, то ее можно снять вызовом одного из следующих свойств и методов: Description, Report или Clear. Если указанные свойства и методы не вызывались, сообщение об ошибке будет автоматически выведено после завершения выполнения команды библиотеки.
Примечание:
Данный интерфейс может быть получен от интерфейса приложения IApplication с помощью свойства IApplication::KompasError.


## Clear - Сбросить ошибку

Синтаксис Automation:
```
void Clear();
```
Синтаксис COM:
```
HRESULT Clear();
```
Примечание:
В результате выполнения метода код ошибки устанавливается в etSuccess (Успешное завершение).


## Code - Код ошибки

Тип данных: из перечисления ErrorType и ErrorType3d.
Синтаксис Automation:
```
Code = iObject.Code    Получить свойство (* )
Code = iObject.GetCode()    Получить свойство (**)
```
Синтаксис COM:
```
iObject->get_Code (&Code)    Получить свойство
```
Примечание:
Свойство доступно только для чтения. Так как коды ошибок из ErrorType и ErrorType3d пересекаются, то для определения из какого перечисления взведена ошибка, нужно воспользоваться свойством Error3D.


## Description - Описание ошибки

Тип данных:BSTR (строка).
Синтаксис Automation:
```
Description = iObject.Description    Получить свойство (* )
Description = iObject.GetDescription()    Получить свойство(**)
```
Синтаксис COM:
```
iObject->get_Description (&Description)    Получить свойство
```
Примечание:
Свойство доступно только для чтения. Позволяет получить символьное описание возникшей ошибки в системе КОМПАС. После выдачи описания ошибки она сбрасывается, т.е. устанавливается в etSuccess (Успешное завершение).


## Error3D - Ошибка для 3D

Тип данных:BOOL.
Синтаксис Automation:
```
Error3D = iObject.Error3D    Получить свойство (* )
Error3D = iObject.GetError3D()    Получить свойство(**)
```
Синтаксис COM:
```
iObject->get_Error3D (&Error3D)    Получить свойство
Значения свойства:
TRUE    - ошибка возникла в 3D API (перечисление ErrorType3d),
FALSE    - ошибка из перечисления ErrorType.
```
Примечание:
Свойство доступно только для чтения. Позволяет определить, какому из двух перечислений соответствует код ошибки, полученный через свойство Code


## Report - Вывести сообщение о ошибке

Синтаксис Automation:
```
void Report();
```
Синтаксис COM:
```
HRESULT Report();
```
Примечание:
В результате выполнения этого метода на экран выводится диалог с описанием возникшей ошибки. После выдачи сообщения о ошибке она сбрасывается, то есть устанавливается в etSuccess (Успешное завершение).
