![]() |
Драйвер контрольно-кассовой техники v.10
|
Установка и сброс параметров методов Подробнее...
Функции | |
DTOX_SHARED_EXPORT void DTOX_SHARED_CCA | libfptr_set_param_bool (libfptr_handle handle, int param_id, int value) |
Устанавливает значение параметра. Подробнее... | |
DTOX_SHARED_EXPORT void DTOX_SHARED_CCA | libfptr_set_param_int (libfptr_handle handle, int param_id, uint value) |
Устанавливает значение параметра. Подробнее... | |
DTOX_SHARED_EXPORT void DTOX_SHARED_CCA | libfptr_set_param_double (libfptr_handle handle, int param_id, double value) |
Устанавливает значение параметра. Подробнее... | |
DTOX_SHARED_EXPORT void DTOX_SHARED_CCA | libfptr_set_param_datetime (libfptr_handle handle, int param_id, int year, int month, int day, int hour, int minute, int second) |
Устанавливает значение параметра. Подробнее... | |
DTOX_SHARED_EXPORT void DTOX_SHARED_CCA | libfptr_set_param_bytearray (libfptr_handle handle, int param_id, const uchar *value, int size) |
Устанавливает значение параметра. Подробнее... | |
DTOX_SHARED_EXPORT int DTOX_SHARED_CCA | libfptr_get_param_bool (libfptr_handle handle, int param_id) |
Возвращает значение параметра. Подробнее... | |
DTOX_SHARED_EXPORT uint DTOX_SHARED_CCA | libfptr_get_param_int (libfptr_handle handle, int param_id) |
Возвращает значение параметра. Подробнее... | |
DTOX_SHARED_EXPORT double DTOX_SHARED_CCA | libfptr_get_param_double (libfptr_handle handle, int param_id) |
Возвращает значение параметра. Подробнее... | |
DTOX_SHARED_EXPORT int DTOX_SHARED_CCA | libfptr_get_param_str (libfptr_handle handle, int param_id, wchar_t *value, int size) |
Возвращает значение параметра. Подробнее... | |
DTOX_SHARED_EXPORT void DTOX_SHARED_CCA | libfptr_get_param_datetime (libfptr_handle handle, int param_id, int *year, int *month, int *day, int *hour, int *minute, int *second) |
Возвращает значение параметра. Подробнее... | |
DTOX_SHARED_EXPORT int DTOX_SHARED_CCA | libfptr_get_param_bytearray (libfptr_handle handle, int param_id, uchar *value, int size) |
Возвращает значение параметра. Подробнее... | |
DTOX_SHARED_EXPORT int DTOX_SHARED_CCA | libfptr_reset_params (libfptr_handle handle) |
Сбрасывает значение всех установленных параметров. Подробнее... | |
Установка и сброс параметров методов
Работа с параметрами методов организована следующим образом.
При установке параметра его значение буферизуется в библиотеке. При вызове метода происходит анализ всех установленных параметров, проверяются и используются их значения. После выполнения метода (с ошибкой или без) буфер параметров очищается.
Хоть у каждого параметра метода и указан его тип, записать и считать его можно любым типом, например:
Наиболее специфичным является тип bytearray. Он рассчитан на чтение/запись тегов ФН и в плане преобразований типов подчиняется их правилам. Это значит, что при преобразовании из/в целое число, будет интерпретироваться как VLN-тип (Описание из ФФД: "<i>целое число без знака, представленное в электронной форме в виде последовательности из нескольких байтов, варьируемой длины с порядком следования байтов от младшего к старшему (variable length bytes)</i>"), при преобразовании из/в числа с плавающей точкой - как тип FVLN (Описание из ФФД: "число с точкой без знака, представленное в электронной форме в виде последовательности из нескольких байтов, варьируемой длины с порядком следования байтов от младшего к старшему, первый байт определяет положение десятичной точки в числе (first byte the point in VLN)"), а при преобразовании из/в строку - как массив байтов с кодировкой CP866.
Исключением является метод libfptr_run_command(), параметры LIBFPTR_PARAM_COMMAND_BUFFER и LIBFPTR_PARAM_ANSWER_BUFFER которого преобразуются из/в строку в виде читаемой интерпретации массива байтов.
enum libfptr_param |
Используемые параметры методов
Параметры LIBFPTR_PARAM_* являются параметрами libfptr10. Значения данных параметров являются параметрами методов интеграционной библиотеки. Использование параметров, отсутствующих в списке, приведет к ошибке выполение метода. Если метод не использует некоторые из переданных параметров, он их проигнорирует.
Параметры, не указанные в этом перечислении и имеющие номера меньше 65535, считаются реквизитами фискального накопителя. При таких значений как входящих параметров методов они будут пересланы в ФН (либо применены как параметры команды ККТ). За подробным описанием реквизитов обращаться в документ "Форматы фискальных документов". Каждый метод библиотеки, помимо указанных у него выходных параметров, может вернуть в параметре LIBFPTR_PARAM_ERROR_TAG_NUMBER номер реквизита, при записи которого произошла ошибка. Текстовое описание ошибки можно прочитать с помощью libfptr_error_description().
См. определение в файле libfptr10.h строка 465
DTOX_SHARED_EXPORT int DTOX_SHARED_CCA libfptr_get_param_bool | ( | libfptr_handle | handle, |
int | param_id | ||
) |
Возвращает значение параметра.
Возвращает логическое представление параметра param_id.
handle | Дескриптор |
param_id | Номер параметра |
1 | - true, 0 - false |
DTOX_SHARED_EXPORT int DTOX_SHARED_CCA libfptr_get_param_bytearray | ( | libfptr_handle | handle, |
int | param_id, | ||
uchar * | value, | ||
int | size | ||
) |
Возвращает значение параметра.
Возвращает значение параметра param_id в виде байтового массива value. Если данный параметр недоступен совсем или имеет несовместимый тип, то вернется ошибка.
handle | Дескриптор |
param_id | Номер параметра |
value | Буфер для значения |
size | Размер буфера |
DTOX_SHARED_EXPORT void DTOX_SHARED_CCA libfptr_get_param_datetime | ( | libfptr_handle | handle, |
int | param_id, | ||
int * | year, | ||
int * | month, | ||
int * | day, | ||
int * | hour, | ||
int * | minute, | ||
int * | second | ||
) |
Возвращает значение параметра.
Возвращает представление параметра param_id как даты и времени. Если данный параметр недоступен совсем или имеет несовместимый тип, то вернется ошибка.
handle | Дескриптор |
param_id | Номер параметра |
year | Год |
month | Месяц |
day | День |
hour | Час |
minute | Минута |
second | Секунда |
DTOX_SHARED_EXPORT double DTOX_SHARED_CCA libfptr_get_param_double | ( | libfptr_handle | handle, |
int | param_id | ||
) |
Возвращает значение параметра.
Возвращает представленное в виде значения с плавающей точкой значение параметра param_id.
handle | Дескриптор |
param_id | Номер параметра |
Число |
DTOX_SHARED_EXPORT uint DTOX_SHARED_CCA libfptr_get_param_int | ( | libfptr_handle | handle, |
int | param_id | ||
) |
Возвращает значение параметра.
Возвращает целочисленное представление параметра param_id.
handle | Дескриптор |
param_id | Номер параметра |
Число |
DTOX_SHARED_EXPORT int DTOX_SHARED_CCA libfptr_get_param_str | ( | libfptr_handle | handle, |
int | param_id, | ||
wchar_t * | value, | ||
int | size | ||
) |
Возвращает значение параметра.
Возвращает строковое представление параметра param_id в value. Если данный параметр недоступен совсем или имеет несовместимый тип, то вернется ошибка.
handle | Дескриптор |
param_id | Номер параметра |
value | Строка |
value | Буфер для строки |
size | Размер буфера |
DTOX_SHARED_EXPORT int DTOX_SHARED_CCA libfptr_reset_params | ( | libfptr_handle | handle | ) |
Сбрасывает значение всех установленных параметров.
handle | Дескриптор |
0 | Успех |
DTOX_SHARED_EXPORT void DTOX_SHARED_CCA libfptr_set_param_bool | ( | libfptr_handle | handle, |
int | param_id, | ||
int | value | ||
) |
Устанавливает значение параметра.
Устанавливает параметру param_id (libfptr_param) логическое значение value. Значение параметра будет проверено и применено при ближайшем вызове метода работы с ККТ, после чего будет удалено.
handle | Дескриптор |
param_id | Номер параметра |
value | Да/Нет |
DTOX_SHARED_EXPORT void DTOX_SHARED_CCA libfptr_set_param_bytearray | ( | libfptr_handle | handle, |
int | param_id, | ||
const uchar * | value, | ||
int | size | ||
) |
Устанавливает значение параметра.
Устанавливает параметру param_id (libfptr_param) байтовый массив value размером size. Значение параметра будет проверено и применено при ближайшем вызове метода работы с ККТ, после чего будет удалено.
handle | Дескриптор |
param_id | Номер параметра |
value | Буфер |
size | Размер буфера |
DTOX_SHARED_EXPORT void DTOX_SHARED_CCA libfptr_set_param_datetime | ( | libfptr_handle | handle, |
int | param_id, | ||
int | year, | ||
int | month, | ||
int | day, | ||
int | hour, | ||
int | minute, | ||
int | second | ||
) |
Устанавливает значение параметра.
Устанавливает параметру param_id (libfptr_param) значение даты (year, month, day) и времени (hour, minute, second). Значение параметра будет проверено и применено при ближайшем вызове метода работы с ККТ, после чего будет удалено.
handle | Дескриптор |
param_id | Номер параметра |
year | Год |
month | Месяц |
day | День |
hour | Час |
minute | Минута |
second | Секунда |
DTOX_SHARED_EXPORT void DTOX_SHARED_CCA libfptr_set_param_double | ( | libfptr_handle | handle, |
int | param_id, | ||
double | value | ||
) |
Устанавливает значение параметра.
Устанавливает параметру param_id (libfptr_param) значение с плавающей точкой value. Значение параметра будет проверено и применено при ближайшем вызове метода работы с ККТ, после чего будет удалено.
handle | Дескриптор |
param_id | Номер параметра |
value | Число |
DTOX_SHARED_EXPORT void DTOX_SHARED_CCA libfptr_set_param_int | ( | libfptr_handle | handle, |
int | param_id, | ||
uint | value | ||
) |
Устанавливает значение параметра.
Устанавливает параметру param_id (libfptr_param) целочисленное значение value. Значение параметра будет проверено и применено при ближайшем вызове метода работы с ККТ, после чего будет удалено.
handle | Дескриптор |
param_id | Номер параметра |
value | Число |