1c native api linux

Технология создания внешних компонент

Введение

Система программ «1С:Предприятие» предназначена для решения самых разнообразных задач автоматизации деятельности организаций. Она обладает мощными средствами конфигурирования, которые позволяют штатными средствами настроить систему на особенности обработки информации в конкретной организации. В тоже время, «1С:Предприятие» является открытой системой. Для связи с другими программами могут использоваться встроенные средства загрузки-выгрузки информации в текстовом формате, в формате XML, система поддерживает стандарт интеграции программ OLE Automation, предоставляет доступ через web-сервисы. Однако для специальных задач интеграции может потребоваться более тесное взаимодействие между «1С:Предприятием» и другими программами.

Для решения таких задач разработана «Технология внешних компонент». Данная технология позволяет создавать программы, которые будут динамически подключаться и тесно взаимодействовать с системой «1С:Предприятие», расширяя ее возможности. Внешние компоненты позволяют решать широкий спектр специальных задач, в частности, задачи, связанные с использованием различного торгового оборудования совместно с «1С:Предприятием». Внешние компоненты могут быть подключены как к серверу приложения 1С:Предприятия, так и клиентским приложениям, в т.ч. и веб-клиенту.

В комплект поставки входит данное руководство и набор примеров реализации внешних компонент с помощью различных технологий.

В данном руководстве описана технология создания внешних компонент с использованием Native API и COM.

Структура каталогов комплекта поставки «Технологии внешних компонент»

Каталог include содержит набор включаемых заголовочных файлов для создания внешних компонент.

Каталог lib содержит статические библиотеки для построения расширений для браузеров Mozilla Firefox, Google Chrome, Safari и Internet Explorer.

Каталог example содержит примеры внешних компонент, разработанных с использованием COM и Native API. В этом же каталоге находятся примеры расширений для браузеров и для мобильной платформы.

Каталог template содержит шаблон для создания компоненты, разработанной по технологии Native API.

Каталог templateMobile содержит шаблон для создания компоненты, разработанной по технологии Native API для мобильной платформы.

Создание компонент c использованием технологии Native API

Эта технология позволяет создавать внешние компоненты, которые могут подключаться как в клиентском приложении, так и на сервере приложений «1С:Предприятие», в версиях для Windows, Linux, а также Windows Runtime, Android и iOS.

Для операционных систем Windows Runtime, Android и iOS использование пользовательского интерфейса запрещено.

Внешняя компонента реализует один или несколько объектов компоненты, которые могут использоваться в «1С:Предприятии». Каждый объект компоненты должен наследоваться от абстрактного класса IComponentBase (файл ComponentBase.h входит в комплект поставки) и реализовать все его методы.

Внешняя компонента, разработанная по этой технологии, должна экспортировать из библиотеки четыре функции:

const WCHAR_T* GetClassNames()

Получение списка имен объектов компоненты.

long GetClassObject(const WCHAR_T* clsName, IComponentBase** pIntf)

Тип: IComponentBase**. Указатель на переменную, в которую нужно записать адрес вновь созданного объекта.

long – не нулевое значение сигнализирует о успешном создании объекта

Создание экземпляра объекта компоненты. Если объект не может быть создан или не найден объект с указанным именем – возвращается 0.

long DestroyObject(IComponentBase** pIntf)

Тип: IComponentBase**. Указатель на объект компонеты.

long – успешность выполнения

Удаление экземпляра ранее созданного объекта. Компонента должна своими средствами удалить объект и освободить используемую им память. При успешном завершении возвращается 0, иначе – код ошибки (Runtime error).

AppCapabilities SetPlatformCapabilities(const AppCapabilities capabilities)

Тип: перечисление AppCapabilities. Значения перечисления: eAppCapabilitiesInvalid = -1, eAppCapabilities1 = 1, eAppCapabilitiesLast = eAppCapabilities1,

Устанавливает версию поддерживаемых платформой возможностей. Компонента должна вернуть версию, с которой она может работать. Если функция не реализована, то для компоненты не будут доступны возможности вывода сообщений, запроса информации о платформе.

Интерфейс компоненты

bool Init(void* Interface)

Тип: void*. Указатель на интерфейс 1С:Предприятия.

bool – успешность выполнения

При загрузке «1С:Предприятие» инициализирует объект компоненты, вызывая метод Init и передавая указатель на IAddInDefBase. Объект может сохранить этот указатель для дальнейшего использования. Объект должен возвратить true, если инициализация прошла успешно, и false при возникновении ошибки.

bool setMemManager(void* memManager)

Тип: void*. Указатель на интерфейс менеджера памяти 1С:Предприятия.

bool – успешность выполнения

Установка менеджера памяти для компоненты. При вызове методов компоненты и передаче возвращаемых значений, которые не могут быть переданы полностью через стек, компонента должна выделять память с помощью функции AllocMemory, предоставляемую менеджером памяти. «1С:Предприятие» впоследствии освободит эту память с помощью функции FreeMemory.

ВАЖНО : нельзя выделять память для возврата значений с помощью new или malloc, т.к. это приведет к утечке памяти и к нестабильности работы программы.

long – версия компоненты

«1С:Предприятие» вызывает этот метод для получения информации о компоненте. Например: версия 3.56 — число 3560.

Возвращаемое значение: нет.

«1С:Предприятие» вызывает этот метод при завершении работы с объектом компоненты. Этот метод вызывается независимо от результата инициализации объекта (метод Init).

bool RegisterExtensionAs(WCHAR_T** wsExtName)

Тип: WCHAR_T**. Наименование расширения встроенного языка 1С:Предприятия.

bool – успешность выполнения

В переменную wsExtName помещается наименование расширения. Память для строки выделяется объектом компоненты функцией AllocMemory менеджера памяти. «1С:Предприятие» освобождает эту память вызовом FreeMemory.

long — количество свойств

Возвращает количество свойств данного расширения, 0 – при отсутствии свойств.

long FindProp(const WCHAR_T* wsPropName);

Тип: const WCHAR_T*. Наименование свойства.

long — порядковый номер свойства.

Возвращает порядковый номер свойства с именем pszPropName; -1, если свойство не найдено. Первое свойство имеет порядковый номер 0.

const WCHAR_T* GetPropName(long lPropNum, long lPropAlias)

Тип: long. Порядковый номер свойства.
Тип: long. Язык наименования:
- 0 — английское наименование;
- 1 — локальное наименование.

В возвращаемое значение помещается имя свойства с порядковым номером lPropNum; если свойство с таким номером отсутствует, возвращается NULL. Память для строки выделяется объектом компоненты функцией AllocMemory менеджера памяти. «1С:Предприятие» освобождает эту память вызовом FreeMemory.

bool GetPropVal(const long lPropNum, tVariant* pvarPropVal)

Тип: tVariant*. Указатель на структуру tVariant, содержащую при возврате значение свойства.

bool – успешность выполнения

В переменную pvarPropVal помещается значение свойства с порядковым номером lPropNum; если свойство с таким номером отсутствует или недоступно для чтения, должен иметь тип VTYPE_EMPTY. Если возвращаемое значение имеет тип строка, то компонента выделяет память для нее функцией AllocMemory. «1С:Предприятие» освободит эту память.

bool SetPropVal(const long lPropNum, tVariant* pvarPropVal);

Тип: tVariant*. Структура tVariant, содержащая новое значение свойства.

bool – успешность выполнения

Переменная pvarPropVal содержит значение свойства с порядковым номером lPropNum; если свойство с таким номером отсутствует, недоступно для записи или тип переданного pvarPropVal не совместим, метод должен возвратить false.

bool IsPropReadable(const long lPropNum)

Тип: const long. Порядковый номер свойства.

Возвращается флаг возможности чтения свойства с порядковым номером lPropNum: false — свойство недоступно для чтения, true — свойство допускает чтение. Если свойство с таким номером отсутствует, метод должен возвращать false.

bool IsPropWritable(const long lPropNum)

Тип: const long. Порядковый номер свойства.

Возвращается флаг возможности записи свойства с порядковым номером lPropNum: false — свойство недоступно для записи, true — свойство допускает запись. Если свойство с таким номером отсутствует, метод должен возвращать false.

Первый метод имеет порядковый номер 0. Первый параметр метода имеет порядковый номер 0.

long — количество методов.

Возвращается количество методов данного расширения, 0 — при отсутствии методов.

long FindMethod(const WCHAR_T* wsMethodName);

Тип: const WCHAR_T*. Имя метода

long — порядковый номер метода

Возвращается порядковый номер метода с именем wsMethodName; -1 — при отсутствии метода.

const WCHAR_T* GetMethodName(const long lMethodNum, const long lMethodAlias)

Тип: const long. Порядковый номер метода.
Тип: const long. Язык имени метода:
- 0 — английское наименование;
- 1 — локальное наименование.

const WCHAR_T* — название метода

Возвращается имя метода с порядковым номером; если свойство с таким номером отсутствует, возвращается NULL. Память для строки выделяется объектом компоненты функцией AllocMemory менеджера памяти. «1С:Предприятие» освобождает эту память вызовом FreeMemory.

long GetNParams(const long lMethodNum)

Тип: const long. Порядковый номер метода.

long — количество параметров метода

Возвращается количество параметров метода с порядковым номером lMethodNum; если метод с таким номером отсутствует или не имеет параметров, возвращается 0.

bool GetParamDefValue(const long lMethodNum, const long lParamNum, tVariant* pvarParamDefValue)

Тип: const long. Порядковый номер метода.
Тип: const long. Порядковый номер параметра.

Тип: tVariant*. Указатель на структуру tVariant, содержащую при возврате значение параметра по умолчанию.

bool — истина, если операция завершена успешно (вне зависимости от наличия у параметра значения по умолчанию)

В переменную pvarParamDefValue помещается значение по умолчанию параметра с номером lParamNum метода с порядковым номером lMethodNum. В pvarParamDefValue помещается тип VTYPE_EMPTY, если метод с таким номером отсутствует, не имеет параметра с номером или параметр не имеет значения по умолчанию. В случае, если значение по умолчанию имеет тип VTYPE_PSTR, VTYPE_PWSTR или VTYPE_BLOB, компонента выделяет память функцией AllocMemory менеджера памяти, записывает туда данные и сохраняет этот адрес в соответствующем поле структуры. «1С:Предприятие» освободит эту память вызовом FreeMemory.

bool HasRetVal(const long lMethodNum)

Тип: const long. Порядковый номер метода.

Возвращается флаг наличия у метода с порядковым номером lMethodNum возвращаемого значения: true для методов с возвращаемым значением и false в противном случае.

bool CallAsProc(const long lMethodNum, tVariant* paParams, const long lSizeArray)

Тип: tVariant* Указатель на массив структур tVariant, содержащий значения параметров метода. Если метод не имеет параметров, то содержит NULL.

Тип: const long. Размер массива paParams.

true – соответствующий метод вызван, ошибок не произошло.
false – отсутствует метод или произошла ошибка времени исполнения (runtime error).

bool CallAsFunc(const long lMethodNum, tVariant* pvarRetValue, tVariant* paParams, const long lSizeArray)

Тип: tVariant*. Указатель на структуру tVariant, содержащую возвращаемое значение.

Тип: tVariant*. Указатель на массив структур tVariant, содержащий значения параметров метода. Если метод не имеет параметров, то содержит NULL.

Тип: const long. Размер массива paParams.

true – соответствующий метод вызван, ошибок не произошло.
false – отсутствует метод или произошла ошибка времени исполнения (runtime error).

Выполняется метод с порядковым номером lMethodNum. Если метод возвращает false, возникает ошибка времени выполнения и выполнение модуля 1С:Предприятия прекращается. Память для массива параметров выделяется «1С:Предприятием». Если возвращаемое значение имеет тип строка или двоичные данные, компонента выделяет память функцией AllocMemory менеджера памяти, записывает туда данные и сохраняет этот адрес в соответствующем поле структуры. «1С:Предприятие» освободит эту память вызовом FreeMemory.

Локализация

void SetLocale(const WCHAR_T* wsLocale)

Тип: const WCHAR_T*. Строка локализации в формате _ . Например: для Linux – «ru_RU», для Windows — «rus_RUS».

«1С:Предприятие» вызывает этот метод для локализации компоненты в соответствии с используемым кодом локализации. Компонента может настроить свое окружение для правильного вывода информации.

Интерфейс 1С:Предприятия

При инициализации объекта компоненты, ему передается указатель на интерфейс 1С:Предприятия, с помощью которого можно вызывать ниже перечисленные методы. Следует помнить, что эти методы не будут работать на сервере приложений.

bool AddError(unsigned short wcode, const WCHAR_T* source, const WCHAR_T* descr, long scode)

Тип: unsigned short. Код сообщения.
Тип: const WCHAR_T*. Источник ошибки.
Тип: const WCHAR_T*. Сообщение ошибки.
Тип: Код ошибки.

Добавляет информационное сообщение при работе методов расширения языка. Если возвращаемое значение true – информация об ошибке успешно добавлена. Если scode имеет не нулевое значение – будет сгенерировано исключение, которое может быть перехвачено и обработано средствами встроенного языка «1С:Предприятия».

Возможные коды сообщений и поведение 1С:Предприятия подробно описаны в разделе «Информационные сообщения о работе объекта» для COM-компонент.

bool RegisterProfileAs(WCHAR_T* wsProfileName)

Тип: WCHAR_T*. Наименование списка параметров компоненты.

Регистрирует список параметров компоненты с именем wsProfileName.

bool Read(WCHAR_T* pszPropName, tVariant* pVal, long* pErrCode, WCHAR_T** errDescriptor)

Тип: WCHAR_T*. Имя параметра

Тип: tVariant _t*. Указатель на возвращаемое значение параметра

Тип: long*. Указатель на переменную, куда будет помещен код ошибки, если возникнет.

Тип: WCHAR_T**. Двойной указатель на переменную, куда будет помещено описание ошибки.

Читает сохраненное значение параметра компоненты с именем pszPropName. В случае неудачи чтения, и ненулевого значения errDescriptor, «1С:Предприятие» выделит память и поместит описание ошибки. Компонента должна освободить память вызовом FreeMemory. Для возвращаемых данных типа строка, память также выделяется «1С:Предприятие»м и адрес сохраняется в соответствующем поле структуры tVariant. Компонента должна освободить ее вызовом FreeMemory.

bool Write(WCHAR_T* pszPropName, tVariant* pVar)

Тип: WCHAR_T*. Имя параметра

Тип: tVariant _t*. Указатель на значение параметра

Сохраняет значение параметра компоненты с именем pszPropName. В случае неудачи возвращается false.

bool SetEventBufferDepth( long lDepth)

Тип: long. Длина очереди событий.

bool. True – новый размер установлен.

Устанавливает размер очереди событий для данного объекта. Если текущее количество событий в очереди больше устанавливаемой длины, последние события удаляются.

long — длина очереди событий.

Возвращается размер очереди событий для данного объекта.

bool ExternalEvent(WCHAR_T* wsSource, WCHAR_T* wsMessage, WCHAR_T* wsData)

Тип: WCHAR_T*. Строка с наименованием источника события.
Тип: WCHAR_T*. Строка с наименованием события.
Тип: WCHAR_T*. Строка c параметрами события.

true – событие помещено в очередь
false – очередь переполнена, обработка событий недоступна или неизвестная ошибка

Помещает событие в очередь, записывая источник события, наименование и параметры события. При обработке события эти данные передаются процедуре ОбработкаВнешнегоСобытия. При вызове метода ExternalEvent дальнейшая обработка события происходит следующим образом: событие записывается в очередь событий (если очередь полностью занята, событие теряется), затем при отсутствии системных событий из очереди берется первое событие (если очередь не пуста) и запускается процесс обработки внешних событий. Этот процесс повторяется для всех объектов внешних компонент. Таким образом, обработка внешних событий синхронизируется с обработкой системных событий.

Очищает очередь событий, удаляя все присутствующие в очереди события.

bool SetStatusLine(WCHAR_T* wsStatusLine)

Тип: WCHAR_T*. Текст строки состояния.

true — текст отображен в строке состояния
false – функция недоступна или неизвестная ошибка

Устанавливает текст строки состояния.

Инициализирует строку состояния.

IInterface* GetInterface(Interfaces iface)

Тип: Interfaces. Значение перечисления Interfaces: eIMsgBox, eIPlatformInfo

Iinterface* — указатель на запрашиваемый интерфейс.

Запрашивает интерфейс платформы. Если запрашиваемый интерфейс поддерживается платформой, будет возвращен указатель на интерфейс. Иначе — 0.

bool Confirm(const WCHAR_T* queryText, tVariant* retVal)

Тип: WCHAR_T*. Текст вопроса.
Тип: tVariant*. Возвращаемое значение диалога. Тип VTYPE_BOOL. Значение true соответствует кнопке ОК, false – Отмена.

bool — истина, если диалог отображен.

Выводит диалог с текстом, заданным параметром queryText, и кнопками ОК и Отмена.

bool Alert(const WCHAR_T* text)

Тип: WCHAR_T*. Текст сообщения.

bool — истина, если диалог отображен.

Выводит простой диалог уведомления с текстом, заданным параметром text и кнопкой ОК.

AppInfo* — указатель на структуру с полями: AppVersion — Тип: WCHAR_T*, версия приложения, Application — Тип: перечисление, тип подключившего компоненту приложения, UserAgentInformation — Тип: WCHAR_T*, информация о браузере (только для веб-клиента)

Запрашивает информацию о платформе. При подключении компоненты в веб-клиенте версии платформы ниже 8.3.3, будет заполнено только поле Application структуры AppInfo.

Соответствие типов tVariant и 1С:Предприятия

Соответствие между типами 1С:Предприятия и COM:

VTYPE_EMPTY соответствует неопределенному значению. При передаче в качестве параметра метода подставляется значение параметра по умолчанию;
значения типа VTYPE_I2, VTYPE_I4, VTYPE_ERROR, VTYPE_UI1 соответствуют целочисленному значению и находятся в lVal;
значения типа VTYPE_BOOL, соответствуют булевому значению и находятся в bVal;
значения типа VTYPE_R4, VTYPE_R8, VTYPE_CY соответствуют дробному значению и находятся в dblVal;
значение типа VTYPE_DATE соответствует значению даты и находится в date;
значение типа VTYPE_TM соответствует значению даты и находится в struct tm tmVal;
значение типа VTYPE_PSTR соответствует строковому значению (char*) и находится в pstrVal с указанием длины в strLen;
значение типа VTYPE_PWSTR соответствует строковому значению (WCHAR_T*) и находится в pwstrVal с указанием длины в wstrLen;
значение типа VTYPE_BLOB соответствует двоичным данным и находится в pstrVal с указанием длины в strLen;

Типы VTYPE_INTERFACE, VTYPE_VARIANT не поддерживаются.

Примечание:
Числовые значения, переданные в качестве параметров из веб-клиента, могут приходить с любым числовым типом.

Тип VTYPE_BLOB не поддерживается в веб-клиенте.

Особенности разработки компонент с использованием Native API

Компонента с использованием этой технологии является платформозависимой. Поэтому разработчик должен строить вариант компоненты как для x86 платформы, так и для x86-64. В процессе использования, разработчик конфигурации определит тип платформы и загрузит нужный вариант компоненты.

Так же следует помнить, что компонента может быть загружена на сервере приложений 1С:Предприятия под управлением любой ОС. Поэтому желательно реализацию делать кроссплатформенной.

«1С:Предприятие» работает со строками в формате Unicode (WCHAR_T) с размером символа 2 байта. Размерность совпадает со встроенным типом wchar_t для ОС Windows, но может отличаться для остальных ОС, где, например, размер wchar_t, может составлять 4 байта. Разработчик компоненты должен самостоятельно выполнять преобразование символьных данных этого типа.

Если внешняя компонента использует дополнительные модули, это нужно указывать в документации к компоненте. Используемые не системные run-time библиотеки должны быть статически включены в компоненту (если позволяет лицензия на run-time библиотеку), так как на компьютере, где будет использоваться компонента, их может не оказаться или они могут быть другой версии. Так же в компоненту для Windows нужно включать манифест.

При возникновении исключительных ситуаций, они должны быть перехвачены и обработаны в компоненте, а информация о них передана в «1С:Предприятие» с помощью метода AddError.

В случае использования компоненты на сервере приложений 1С:Предприятия, внешние события не обрабатываются. Также не будут обрабатываться методы работы со строкой статуса и сохранения параметров.

Компонента может возвращать любые двоичные данные, например – сформированное изображение штрих-кода. Для этого данные помещаются в поле pstrVal структуры tVariant, в strLen – размер данных, а тип устанавливается в VTYPE_BLOB. «1С:Предприятие» использует для них тип ДвоичныеДанные.

Значение даты передается во внешнюю компоненту в виде структуры tm и указанием типа VTYPE_TM. Компонента может вернуть значение даты как в struct tm, так и в типе DATE Windows, указав тип VTYPE_DATE. «1С:Предприятие» обработает его корректно.

Возвращаемые значения типа VTYPE_ARRAY и VTYPE_BYREF не поддерживаются.

Настройки Web-публикации для мобильной платформы «1С:Предприятие»

Во время настройки Web-публикации следует провести следующее действие. В настройках http-сервера необходимо добавить типы MIME для следующих расширений:

Тип MIME: application/octet-stream

ОС Windows Runtime

Для разработки под ОС Windows Runtime требуется установленная минимум Windows 8.1 с MS Visual Studio 2017 (пакет Windows Phone SDK).

Результатом разработки компоненты должна быть группа динамических библиотек *.dll для мобильных и планшетов всех поддерживаемых процессоров.

Примеры проектов внешней компоненты находятся в каталоге \example\NativeAPIMobile\WinRT_Proj\.

Отладка внешней компоненты проводится с помощью проектов, находящихся в поставке mobile.zip\Windows\vcproj.zip:

store – проект MS Visual Studio для мобильных приложений;
store_client — проект MS Visual Studio для мобильных клиентов.

Перед применением в директорию appx\ необходимо скопировать содержимое соответствующего архива поставки 1cem-XXXXX.appx.

Далее, добавив исходные коды внешней компоненты, для отладки можно использовать стандартные средства MS Visual Studio.

Для Windows Runtime не реализована возможность загрузки динамических библиотек из Web-публикации.

ОС Android

Разработка под ОС Android поддерживает написание кода на языке программирования c++, так и использование технологии Java Native Interface.

Результатом разработки компоненты под ОС Android должна быть группа динамических библиотек *.so для всех поддерживаемых процессоров. В случае использования кода Java, также должен присутствовать файл *.apk. Файл *.apk не является отдельным приложением и не предназначен для самостоятельного запуска. Впоследствии он включается в состав собранного мобильного приложения.

Пример проекта находится в каталоге \example\NativeAPIMobile\Android_Proj\.

Для отладки внешней компоненты следует использовать возможность загрузки динамических библиотек из Web-публикации. Это происходит автоматически после обновления конфигурации (с вложенными библиотеками) на устройстве с Web-публикации на компьютере разработчика.

ОС iOS

Специфика разработки приложений под iOS не позволяет использование несистемных динамических библиотек для публикации в AppStore. В связи с этим разработчик внешней компоненты должен использовать их только для разработки и отладки.

Результатом разработки компоненты под ОС iOS должен быть файл динамической библиотеки *.dylib для целей тестирования, подписанный сертификатом разработчика и бинарный файл для статической линковки *.a для сборщика приложения.

Отладка внешней компоненты проводится с помощью проекта, находящегося в поставке mobile.zip\iOS\prjios.zip.

Далее, добавив исходные коды внешней компоненты, для отладки можно использовать стандартные средства Xcode.

Для отладки внешней компоненты также можно использовать возможность загрузки динамических библиотек из Web-публикации. Это происходит автоматически после обновления конфигурации (с вложенными библиотеками) на устройстве с Web-публикации на компьютере разработчика.

Начиная с версии ОС iOS 10.0, стала недоступна возможность использования динамических библиотек из Web-публикации. В этом случае, для целей тестирования следует использовать бинарный файл статической библиотеки *.a.

Подпись сертификатом разработчика

Подпись сертификатом разработчика выполняется с помощью утилиты codesign следующей командой:

codesign -s «iPhone Developer» /Users/Somebody/Documents/addin/iOS_Proj/Build/com_1c_StepCounter.dylib

Статическая библиотека

Статическая библиотека *.a предназначена для сборки конечного приложения путем влинковки внешней компоненты в платформу.

Для исключения конфликта имен, код внешней компоненты должен находится в собственном уникальном пространстве имен. Наименование пространства имен должно соответствовать имени внешней компоненты или включать его как составляющую.

Регистрация компоненты производится статически при загрузке приложения. Соответствующий код можно увидеть в примере.

Пример проекта находится в каталоге \example\NativeAPIMobile\iOS_Proj\.

Создание компонент с использованием технологии COM

Технология внешних компонент с использованием COM может также применяться в «1С:Предприятии» более ранних версий (7.7, 8.0 и 8.1).

Создание компонент под Windows Runtime, Android и iOS, с использованием данной технологии, невозможно.

При загрузке внешней компоненты функцией ЗагрузитьВнешнююКомпоненту или ПодключитьВнешнююКомпоненту( , , ТипВнешнейКомпоненты.COM) «1С:Предприятие» определяет ProgID COM—объекта компоненты следующим образом:

ProgID имеет вид . ;
в качестве первой части ( ) используется строка «AddIn»;
в качестве второй части ( ) используется строка с ID 100 из таблицы строк компоненты. Строка может иметь вид «Name1|Name2|. |NameN», и в этом случае будут созданы все объекты с ProgID вида «AddIn.NameX». Если такая строка отсутствует, то используется имя файла внешней компоненты без расширения.

При использовании функции ПодключитьВнешнююКомпоненту( ) ProgID COM-объекта компоненты передается в качестве параметра функции и также может представляться строкой вида ProgID1| ProgID2|. |ProgIDX.

Инициализация и выгрузка компоненты

Для инициализации и выгрузки компоненты используется интерфейс IInitDone. Этот интерфейс наследован от IUnknown и предназначен для инициализации объекта и завершения работы с объектом.

HRESULT Init(IDispatch *pBackConnection)

Тип: IDispatch. Указатель на интерфейс 1С:Предприятия.

E_FAIL — при инициализации произошла ошибка
S_OK — инициализация прошла успешно

При загрузке «1С:Предприятие» инициализирует объект компоненты, вызывая метод Init и передавая указатель на IDispatch. Объект может сохранить этот указатель для дальнейшего использования. Все остальные интерфейсы 1С:Предприятия объект может получить, вызвав метод QueryInterface переданного ему интерфейса IDispatch. Объект должен возвратить S_OK, если инициализация прошла успешно, и E_FAIL при возникновении ошибки. Данный метод может использовать интерфейс IerrorLog для вывода информации об ошибках. При этом инициализация считается неудачной, если одна из переданных структур EXCEPINFO имеет поле scode, не равное S_OK. Все переданные в IErrorLog данные обрабатываются при возврате из данного метода. В момент вызова этого метода свойство AppDispatch не определено.

S_OK — объект завершил работу

«1С:Предприятие» вызывает этот метод при завершении работы с объектом компоненты. Объект должен возвратить S_OK. Этот метод вызывается независимо от результата инициализации объекта (метод Init).

HRESULT GetInfo(SAFEARRAY** pInfo)

Тип: SAFEARRAY**. Двойной указатель на массив структур VARIANT. Память для массива выделяется «1С:Предприятием».

S_OK — информация о компоненте возвращена

«1С:Предприятие» вызывает этот метод для получения информации о компоненте. В текущей версии 2.0 компонентной технологии в элемент с индексом 0 необходимо записать версию поддерживаемой компонентной технологии в формате V_I4 — целого числа, при этом старший номер версии записывается в тысячные разряды, младший номер версии — в единицы. Например: версия 3.56 — число 3560. В настоящее время все объекты внешних компонент могут поддерживать версию 1.0 (соответствует числу 1000) или 2.0 (соответствует 2000). Память для pInfo выделяется «1С:Предприятием». Метод должен возвращать S_OK.

Объект внешней компоненты обязан реализовать этот интерфейс. При его отсутствии компонента не будет загружена.

Расширение встроенного языка

Для расширения встроенного языка компонента должна реализовать интерфейс ILanguageExtender. Этот интерфейс унаследован от IUnknown и предназначен для расширения встроенного языка 1С:Предприятия. Для использования этого расширения необходимо вызвать функцию СоздатьОбъект (Новый в «1С:Предприятии 8»), передав ей строку вида «AddIn. «, где возвращается методом этого интерфейса. Затем можно использовать созданный объект, вызывая его методы и свойства.

Версия 2.0 позволяет создавать несколько объектов одного типа «AddIn. «, однако компонента должна явно указать поддержку версии 2.0 в методе GetInfo. В противном случае допускается создание только одного объекта.

HRESULT RegisterExtensionAs(BSTR *pExtensionName)

Тип: BSTR*. Наименование расширения встроенного языка 1С:Предприятия.

S_OK — операция завершена успешно.

В переменную pExtensionName помещается наименование расширения. Память для строки выделяется объектом компоненты стандартными системными функциями для работы с COM—строками (например, SysAllocString. «1С:Предприятие» освобождает эту память вызовом SysFreeString).

HRESULT GetNProps(long* plProps)

Тип: long*. Указатель на переменную, содержащую при возврате количество свойств расширения.

S_OK — операция завершена успешно.

Возвращает количество свойств данного расширения, 0 – при отсутствии свойств. Память для переменной plProps выделяется «1С:Предприятием».

HRESULT FindProp(BSTR pszPropName,long* plPropNum)

Тип: BSTR. Наименование свойства.

Тип: long*. Указатель на переменную, содержащую при возврате порядковый номер свойства.

S_OK — операция завершена успешно
S_FALSE — свойство с именем pszPropName в данном расширении отсутствует

Возвращает порядковый номер свойства с именем pszPropName; -1, если свойство не найдено. Первое свойство имеет порядковый номер 0. Память для переменной plPropNum выделяется «»1С:Предприятием».

HRESULT GetPropName(long lPropNum,long lAliasNum,BSTR* pPropName)

Тип: long. Порядковый номер свойства.
Тип: long. Язык наименования:
0 — английское наименование;
1 — локальное наименование.

Тип: BSTR*. Указатель на строку, содержащую при возврате наименование свойства.

S_OK — операция завершена успешно
S_FALSE — свойство с номером lPropNum в данном расширении отсутствует

В переменную pPropName помещается имя свойства с порядковым номером lPropNum; если свойство с таким номером отсутствует, в pPropName помещается пустая строка. Память для строки выделяется объектом компоненты стандартными системными функциями для работы с COM—строками (например, SysAllocString. «1С:Предприятие» освобождает эту память вызовом SysFreeString).

HRESULT GetPropVal(long lPropNum,VARIANT* pvPropVal)

Тип: VARIANT*. Указатель на структуру VARIANT, содержащую при возврате значение свойства.

S_OK — операция завершена успешно
S_FALSE — свойство с номером lPropNum в данном расширении отсутствует или недоступно для чтения.

В переменную pvPropVal помещается значение свойства с порядковым номером lPropNum, если свойство с таким номером отсутствует или недоступно для чтения, переменная должна иметь тип VT_EMPTY.

HRESULT SetPropVal(long lPropNum, VARIANT* pvPropVal)

Тип: VARIANT*. Структура VARIANT, содержащая новое значение свойства.

S_OK — операция завершена успешно
S_FALSE — свойство с номером lPropNum в данном расширении отсутствует или недоступно для записи.

Переменная pvPropVal содержит значение свойства с порядковым номером lPropNum; если свойство с таким номером отсутствует, недоступно для записи или тип переданного pvPropVal не приводится к необходимому, метод должен возвратить S_FALSE.

HRESULT IsPropReadable(long lPropNum, BOOL* pboolPropReadable)

Тип: BOOL*. Указатель на переменную, содержащую при возврате флаг возможности чтения свойства.

S_OK — операция завершена успешно.
S_FALSE — свойство с номером lPropNum в данном расширении отсутствует.

В переменную pboolPropReadable помещается флаг возможности чтения свойства с порядковым номером lPropNum: FALSE(0) — свойство недоступно для чтения, TRUE(1) — свойство допускает чтение. Если свойство с таким номером отсутствует, метод должен возвращать S_FALSE.

HRESULT IsPropWritable(long lPropNum, BOOL* pboolPropWritable)

Тип: BOOL*. Указатель на переменную, содержащую при возврате флаг возможности записи свойства.

S_OK — операция завершена успешно.
S_FALSE — свойство с номером lPropNum в данном расширении отсутствует.

В переменную pboolPropWritable помещается флаг возможности записи свойства с порядковым номером lPropNum: FALSE(0) — свойство недоступно для записи, TRUE(1) — свойство допускает запись. Если свойство с таким номером отсутствует, метод должен возвращать S_FALSE.

Первый метод имеет порядковый номер 0. Первый параметр метода имеет порядковый номер 0.

HRESULT GetNMethods(long* plMethods)

Тип: long*. Указатель на переменную, содержащую при возврате количество методов расширения языка.

В переменную plMethods помещается количество методов данного расширения, 0 — при отсутствии методов.

HRESULT FindMethod(BSTR bstrMethodName, long* plMethNum)

Тип: long*. Указатель на переменную, содержащую при возврате порядковый номер метода с именем methodName.

В переменную plMethNum помещается порядковый номер метода с именем bstrMethodName; -1 — при отсутствии метода.

HRESULT GetMethodName(long lMethodNum, long lAliasNum, BSTR* pbstrMethName)

Тип: long. Порядковый номер метода.
Тип: long. Язык имени метода: 0 — английское наименование, 1 — локальное наименование.

Тип: BSTR*. Указатель на строку, содержащую при возврате имя метода.

S_OK — операция завершена успешно
S_FALSE — метод с номером lMethodNum в данном расширении отсутствует

В переменную pbstrMethName помещается имя метода с порядковым номером; если свойство с таким номером отсутствует, в помещается пустая строка. Память для строки выделяется объектом компоненты стандартными системными функциями для работы с COM—строками (например, SysAllocString. «1С:Предприятие» освобождает эту память вызовом SysFreeString).

HRESULT GetNParams(long lMethodNum, long* plMethParams)

Тип: long*. Указатель на переменную, содержащую при возврате количество параметров метода.

S_OK — операция завершена успешно
S_FALSE — метод с номером lMethodNum в данном расширении отсутствует

В переменную plMethParams помещается количество параметров метода с порядковым номером lMethodNum; если метод с таким номером отсутствует или не имеет параметров, в помещается 0. Память для переменной выделяется «1С:Предприятие»м.

HRESULT GetParamDefValue(long lMethodNum, long lParamNum, VARIANT* pvParamDefVal)

Тип: long. Порядковый номер метода.
Тип: long. Порядковый номер параметра.

Тип: VARIANT*. Указатель на структуру VARIANT, содержащую при возврате значение параметра по умолчанию.

S_OK — операция завершена успешно (вне зависимости от наличия у параметра значения по умолчанию)
S_FALSE — метод или параметр метода отсутствует

В переменную pvParamDefVal помещается значение по умолчанию параметра lParamNum метода с порядковым номером lMethodNum. В pvParamDefVal помещается тип VT_EMPTY, если метод с таким номером отсутствует, не имеет параметра с номером или параметр не имеет значения по умолчанию. Память для переменной выделяется «1С:Предприятием».

HRESULT HasRetVal(long lMethodNum,BOOL* pboolHasRetVal)

Тип: BOOL*. Указатель на переменную, содержащую при возврате флаг наличия возвращаемого значения.

S_OK — операция завершена успешно
S_FALSE — метод отсутствует

В переменную pboolHasRetVal помещается флаг наличия возвращаемого значения у метода с порядковым номером lMethodNum: TRUE для методов с возвращаемым значением и FALSE в противном случае. Память для переменной выделяется «1С:Предприятие»м.

HRESULT CallAsProc(long lMethodNum, SAFEARRAY** pVars)

Тип: SAFEARRAY**. Двойной указатель на массив структур VARIANT, содержащий значения параметров метода. Если метод не имеет параметров, то содержит NULL.

S_OK — соответствующий метод вызван, ошибок не произошло.
E_FAIL — соответствующий метод вызван, произошла ошибка времени исполнения (runtime error). Исполнение модуля прекращается.
S_FALSE – отсутствует метод, соответствующий переданному lMethodNum.

Выполняется метод с порядковым номером lMethodNum. Если метод возвращает E_FAIL, возникает ошибка времени выполнения и выполнение модуля 1С:Предприятия прекращается. Память для массива параметров выделяется «1С:Предприятие»м.

HRESULT CallAsFunc(long lMethodNum, VARIANT* pRetValue, SAFEARRAY** pVars)

После стандартного заголовка XML следует тег .

Разрешается добавлять информацию только в теги и . Теги могут быть в любой очередности.

Теги в атрибуте name=»…» указывают сборщику полный путь и наименование подсистемы.

Все содержимое тега (тегов) без анализа и изменений вносится сборщиком в корневой тег файла Info.plist.

Описание файла ANDROID_MANIFEST_EXTENSIONS.XML

Файл ANDROID_MANIFEST_EXTENSIONS.XML используется сборщиком только для ОС Android. Предназначен для внесения изменений в манифесте AndroidManifest.xml, например добавления прав, необходимых для внешней компоненты к определенным компонентам или функциональности данного приложения. Файл необязателен и его отсутствие расценивается сборщиком как отсутствие дополнительных изменений в AndroidManifest.xml.

Формат рассмотрим на примере:

После стандартного заголовка XML следует тег с фиксированным атрибутом. Тег аналогичен тегу в файлах AndroidManifest.xml.

Строки внутри тега добавляются в тег манифеста Android без изменения и анализа, за исключением тегов .

Все что находится в тегах вставится в указанную в атрибуте xpath=»…» часть AndroidManifest.xml.

Есть возможность локализовать влияние строк на конкретные пакеты указав «%application.package%. . «.

Разрешается добавлять информацию только в тег и (файлов AndroidManifest.xml).

Описание атрибутов для uses-permission, uses-feature и т.п. можно найти в документации разработчика Android.

Не рекомендуется добавлять в теги uses-permission атрибуты, указывающие максимальную версию SDK. Это может привести к конфликтам в случае сборки приложений с несколькими внешними компонентами.

Описание файла WINDOWS_RT_MANIFEST_EXTENSIONS.XML

Файл WINDOWS_RT_MANIFEST_EXTENSIONS.XML используется сборщиком для ОС Windows Runtime. Предназначен для внесения изменений в манифесте AppxManifest.xml, например добавления прав, необходимых для внешней компоненты к определенным компонентам или функциональности данного приложения. Файл необязателен и его отсутствие расценивается сборщиком как отсутствие дополнительных изменений в настройках разрешений.

Формат рассмотрим на примере:

После стандартного заголовка XML следует тег .

Разрешается добавлять информацию только в тег .

Теги в атрибуте xpath=»…» указывают сборщику пункт назначения параметров «Name=’XXXXX'» в файле AppxManifest.xml.

Описание тегов и можно найти в документации разработчика для Windows.

Правила формирования имени внешней компоненты для мобильной платформы «1C:Предприятие»

В связи с тем, что, в общем случае, в мобильном приложении может использоваться несколько внешних компонент от разных разработчиков, и с целью исключения конфликтов имен необходимо соблюдать следующие правила формирования имени внешней компоненты.

Имя внешней компоненты должно состоять из латинских букв и/или цифр и не может включать пробелы. Разрешается также использования знака подчеркивания (_). Первым символом может быть только буква или символ подчеркивания (_). Имя компоненты чувствительно к регистру клавиатуры.

Если программа создается в организации, у которой есть свой интернет-сайт, и доменное имя такого сайта, например, 1c.com, то имя внешней компоненты должно начинаться с этих же слов, выписанных в обратном порядке: com_1c. Точки заменяются на знак подчеркивания (_). Далее через (_) следует имя самой внешней компоненты.

Если имя сайта противоречит требованиям к имени внешней компоненты, то можно предпринять следующие шаги:

если в имени стоит запрещенный символ, например тире, то его можно заменить знаком подчеркивания;
если имя совпадает с зарезервированным словом, то можно в конце добавить знак подчеркивания;
если имя начинается с цифры, можно вначале добавить знак подчеркивания.

Ограничения в работе внешних компонент

Разработчик должен учитывать, что внешняя компонента может быть подключена как в оконном приложении (тонкий клиент, толстый клиент), так и в консольном (например: на сервере 1С:Предприятия или в веб-клиенте), где может отсутствовать главное окно и оконная система, очередь сообщений, таймеры, использующие очередь сообщений, нет возможности поставить локальный хук, например, на клавиатуру. В этом случае, разработчик компоненты должен самостоятельно позаботиться о создании необходимого окружения для корректной работы внешней компоненты

В случае использования технологии внешних компонент в мобильной платформе запрещен вызов методов

bool ADDIN_API Confirm(const WCHAR_T* queryText, tVariant* retVal);
bool ADDIN_API Alert(const WCHAR_T* text);

из системного потока, т.к. показ модальных окон в таком случае может вызвать «зависание» приложения.

Для Windows Runtime не реализована возможность загрузки динамических библиотек из Web-публикации.

Для iOS возможность загрузки динамических библиотек из Web-публикации разрешена со стороны ОС только до версии iOS 9.3.5 включительно.

Описание примеров

В поставку настоящей методики входят примеры реализации внешних компонент, разработанных с использованием технологий Native API и СОМ, расширений для Mozilla Firefox, Google Chrome и Internet Explorer. Кроме примера в поставку включен шаблон, позволяющий упростить создание компоненты «с нуля».

Реализации компонент максимально приближены друг к другу (одинаковые идентификаторы, названия и т.д.), что упрощает процесс освоения и разбора различных реализаций.

В связи со спецификой использования, пример для мобильной платформы отличается от остальных. В нем реализуется упрощенный шагомер. Располагается в каталоге \example\NativeAPIMobile\.

Для полной сборки примеров для персонального компьютера, разработчику понадобится CMake, версии не ниже 3.6, NSISдля сборки инсталляторов для ОС Windows, makeselfдля сборки инсталляторов для ОС GNU/Linux.

Компоненты реализуют следующие свойства и методы:

Примеры внешней компоненты «1С:Предприятие» для персонального компьютера

Свойства

Использование: Чтение и запись.

Описание: Тип: Булево. Содержит состояние компоненты.

Описание: Тип: Булево. Определяет наличие у компоненты таймера.

Источник