Статус документа
Статус документа

ГОСТ Р ИСО/МЭК 19784-1-2007 Автоматическая идентификация. Идентификация биометрическая. Биометрический программный интерфейс. Часть 1. Спецификация биометрического программного интерфейса (с Изменением N 1)

     8.1.12 Функция BioAPI_ControlUnit

BioAPI_RETURN BioAPI BioAPI_ControlUnit

(BioAPI_HANDLE BSPHandle,

BioAPI_UNIT_ID UnitlD,

uint32JControlCode,

const BioAPI_DATA *lnputData,

BioAPI_DATA *OutputData);

8.1.12.1 Описание

Данная функция посылает управляющие данные от приложения модулю БиоАПИ и получает обратно данные состояния или рабочие данные. Содержание параметра ControlCode посылаемых (входных) и получаемых (выходных) данных должно быть определено в спецификации на интерфейс для данного модуля БиоАПИ или связанного ИПФ в том случае, если он присутствует.

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

Блок памяти, возвращенный при вызове функции БиоАПИ, должен быть освобожден приложением путем вызова функции BioAPI_Free (8.7.2).

8.1.12.2 Параметры

BSPHandle (входной) - дескриптор присоединенного ПБУ.

Unitld - ИД модуля БиоАПИ.

ControlCode (входной) - код функции в вызываемом модуле БиоАПИ.

InputData (входной) - указатель на структуру BioAPI-DATA, содержащую адрес и длину буфера данных, которые должны быть посланы модулю БиоАПИ в соответствии с данным ControlCode.

OutputData (выходной) - указатель на структуру BioAPI-DATA. На выходе она должна содержать адрес и длину буфера данных, содержащего данные, полученные от модуля БиоАПИ после обработки функции, указанной в ControlCode. Если функция не выделила область памяти, то адрес должен быть установлен на пустой указатель, а длина буфера задана равной нулю.

8.1.12.3 Возвращаемое значение

Значение BioAPI_RETURN указывает на успешное выполнение функции или определяет тип ошибки. Значение BioAPI_OK указывает на отсутствие ошибки. Все остальные значения описывают тип ошибки.

8.1.12.4 Ошибки

BioAPIERR_BIOAPI_UNIT_NOT_INSERTED

BioAPIERR_INVALID_UNIT_ID

BioAPIERR_UNIT_IN_USE

BioAPIERR_INVALID_BSP_HANDLE


Данные об обработке ошибок БиоАПИ приведены в разделе 11.