Функции и типы, связанные с инициализацией и обработкой ошибок. Подробнее...
Классы | |
struct | ilr_options |
Настройки библиотеки. Подробнее... | |
Определения типов | |
typedef void(ILR_CALL * | ilr_logging_callback) (ilr_log_level nLevel, const char *pContext, const char *pMessage, void *pUserData) |
Тип функции обратного вызова для получения сообщений лога отладки библиотеки. Подробнее... | |
Макросы версии SDK Readers. | |
#define | ILR_VERSION_MAJOR 1 |
Основной номер версии библиотеки SDK Readers. Подробнее... | |
#define | ILR_VERSION_MINOR 0 |
Минорный номер версии библиотеки SDK Readers. Подробнее... | |
#define | ILR_VERSION_PATCH 1 |
Номер патча библиотеки SDK Readers. Подробнее... | |
#define | ILR_VERSION ((ILR_VERSION_MAJOR << 24) | (ILR_VERSION_MINOR << 16) | (ILR_VERSION_PATCH << 8) | 0xC0) |
Полный номер версии библиотеки SDK Readers. | |
#define | ILR_VERSION_GET_MAJOR(v) ((v) >> 24) |
#define | ILR_VERSION_GET_MINOR(v) (((v) >> 16) & 0xff) |
#define | ILR_VERSION_GET_PATCH(v) (((v) >> 8) & 0xff) |
Функции и типы, связанные с инициализацией и обработкой ошибок.
Ссылки на инфо о инициализации и завершении библиотеки, проверке версии и обработке ошибок.
#define ILR_FAILED | ( | status | ) | ((status) != ILR_OK) |
Проверяет код возврата SDK на ошибку.
[in] | status | Код возврата. |
#define ILR_SUCCEEDED | ( | status | ) | ((status) == ILR_OK) |
Проверяет код возврата SDK на успех.
[in] | status | Код возврата. |
#define ILR_VERSION_GET_MAJOR | ( | v | ) | ((v) >> 24) |
Извлекает основной номер из полной версии.
#define ILR_VERSION_GET_MINOR | ( | v | ) | (((v) >> 16) & 0xff) |
Извлекает минорный номер из полной версии.
#define ILR_VERSION_GET_PATCH | ( | v | ) | (((v) >> 8) & 0xff) |
Извлекает номер патча из полной версии.
#define ILR_VERSION_MAJOR 1 |
Основной номер версии библиотеки SDK Readers.
Увеличивается, когда API становится не совместимым с предыдущими версиями.
#define ILR_VERSION_MINOR 0 |
Минорный номер версии библиотеки SDK Readers.
Увеличивается, когда в API добавляются новые возможности, но при этом сохраняется обратная совместимость.
#define ILR_VERSION_PATCH 1 |
Номер патча библиотеки SDK Readers.
Увеличивается, когда выпускается исправление ошибки, не содержащее никаких изменений в API.
typedef void(ILR_CALL * ilr_logging_callback) (ilr_log_level nLevel, const char *pContext, const char *pMessage, void *pUserData) |
Тип функции обратного вызова для получения сообщений лога отладки библиотеки.
Функция имеет следующий вид:
[in] | nLevel | Уровень лога. |
[in] | pContext | Контекст. |
[in] | pMessage | Текст сообщения. |
[in] | pUserData | Указатель на данные пользователя. |
enum ilr_status |
Коды ошибок.
Элементы перечислений | |
---|---|
ILR_OK | Операция успешно выполнена. |
ILR_E_FAIL | Неизвестная ошибка. |
ILR_E_PENDING | Операция выполняется асинхронно. |
ILR_E_BOUNDS | Индекс вне диапазона. |
ILR_E_NOTIMPL | Команда не поддерживается считывателем. |
ILR_E_POINTER | Неправильный указатель. |
ILR_E_ABORT | Операция прервана. |
ILR_E_HANDLE | Неправильный дескриптор. |
ILR_E_OUTOFMEMORY | Недостаточно памяти. |
ILR_E_INVALIDARG | Неправильные параметры. |
ILR_E_WRONG_SDK_VERSION | Неправильная версия Sdk Readers передана в функцию ilr_init. |
ILR_E_NOT_INITIALIZED | Библиотека не инициализирована с помощью ilr_init. |
ILR_E_OUT_OF_RESOURCES | Недостаточно ресурсов для завершения операции. |
ILR_E_BUFFER_TOO_SMALL | Размер буфера слишком мал |
ILR_E_BLOCKING_CALL_NOT_ALLOWED | Блокирующий вызов функции из обработчика не разрешен. |
ILR_E_PORT_NOT_EXIST | Порт не существует. |
ILR_E_PORT_ACCESS_DENIED | Нет доступа к порту. |
ILR_E_PORT_OPEN_FAILED | Неизвестная ошибка открытия порта. |
ILR_E_CONNECTION_ERROR | Ошибка подключения. |
ILR_E_CONNECTION_DOWN | Связь с устройством была потеряна. |
ILR_E_REQUEST_TIMEOUT | Тайм-аут запроса к считывателю. |
ILR_E_BAD_RESPONSE | Не распознан ответ считывателя. |
ILR_E_SCARD_ERROR | Ошибка функции Smart Cards. |
ILR_E_READER_ERROR | Ошибка считывателя. |
ILR_E_NO_CARD | Нет карты. |
ILR_E_CARD_NACK | Карта отказала от выполнения команды. |
ILR_E_CARD_AUTH | Ошибка авторизации карты. |
ILR_E_MIFARE_ADDRESS | Неправильный адрес Mifare. |
ILR_E_MIFARE_VALUE | Ошибка блока-значения Mifare. |
ILR_E_CARD_PAGE_LOCK | Страница карты заблокирована. |
ILR_E_WRITE_T57 | Не удалось записать на Temic. |
ILR_STATUS_SIZE | Размер списка ошибок. |
|
inline |
Проверяет версию SDK.
Возвращает true
если версия библиотеки совместима с этим заголовочным файлом.
ILR_API ilr_status ILR_CALL ilr_cleanup | ( | ) |
Освобождает ресурсы библиотеки.
Освобождает память и закрывает все дескрипторы библиотеки.
ILR_OK
.ILR_API const char *ILR_CALL ilr_get_error_text | ( | ilr_status | nErrorCode | ) |
Возвращает описание ошибки по её коду.
[in] | nErrorCode | Код ошибки. |
ILR_API ilr_status ILR_CALL ilr_get_options | ( | ilr_options * | pOptions | ) |
Возвращает глобальные настройки библиотеки.
[out] | pOptions | Опции библиотеки. |
ILR_OK
в случае успеха или код ошибки в случае неудачи. Возвращает номер версии библиотеки.
ILR_API ilr_status ILR_CALL ilr_init | ( | uint32_t | nVersionRequested = ILR_VERSION | ) |
Инициализирует библиотеку SDK Readers.
Эта функция инициализирует библиотеку SDK Readers. Функция ilr_init должна быть вызвана первой перед вызовом других функций, кроме ilr_get_version, ilr_get_error_text, ilr_set_log_level, ilr_set_log_callback и ilr_free_memory. Завершив использование библиотеки приложение должно вызвать ilr_cleanup, чтобы библиотека освободила внутренние ресурсы. Приложение должно вызвать ilr_cleanup при каждом успешном вызове ilr_init, т.к. используется внутренний счётчик инициализаций.
[in] | nVersionRequested | Номер версии API SDK Readers, всегда должно быть равен ILR_VERSION. |
ILR_OK
в случае успеха, иначе код ошибки. `ILR_E_WRONG_SDK_VERSION` | запрошенная версия SDK не поддерживается. |
ILR_API ilr_status ILR_CALL ilr_set_log_callback | ( | ilr_logging_callback | pCallback, |
void * | pUserData = nullptr |
||
) |
Устанавливает функцию обратного вызова для лога отладки.
[in] | pCallback | Указатель на функцию, которую библиотека будет вызывать для передачи сообщений лога отладки. |
[in] | pUserData | Указатель на данные пользователя, который будет передаваться в функцию. |
ILR_E_BLOCKING_CALL_NOT_ALLOWED
.ILR_OK
. ILR_API ilr_status ILR_CALL ilr_set_log_level | ( | ilr_log_level | nLevel | ) |
Устанавливает уровень лога отладки.
[in] | nLevel | Уровень лога отладка. |
ILR_OK
. ILR_API ilr_status ILR_CALL ilr_set_options | ( | const ilr_options * | pOptions | ) |
Устанавливает глобальные настройки библиотеки.
[in] | pOptions | Опции библиотеки. |
ILR_OK
в случае успеха или код ошибки в случае неудачи.