Интеграция с ПО UPOS через библиотеку PILOT_NT. 1.0 Платформа Win32.

- Титульная страница
- Группы
- Структуры данных

Функции
Функции работы с контекстом pilot_nt.dll
Библиотека pilot_nt.dll » Служебные операции pilot_nt.dll

## Функции

PILOT_NT_API CONTEXT_PTR | ctxAlloc (void)
| Создать контекст операции. Функция создает пустой контекст операции. Подробнее...
PILOT_NT_API void | ctxFree (CONTEXT_PTR ctx)
| Удалить контекст операции Подробнее...
PILOT_NT_API void | ctxClear (CONTEXT_PTR ctx)
| Отчистить контекст. Функция удаляет все параметры из контекста. Подробнее...
PILOT_NT_API int | ctxSetString (CONTEXT_PTR ctx, EParameterName name, const char *str)
| Записать в контекст значение строкового параметра. Подробнее...
PILOT_NT_API int | ctxSetInt (CONTEXT_PTR ctx, EParameterName name, int val)
| Записать в контекст значение целочисленного параметра. Подробнее...
PILOT_NT_API int | ctxSetBinary (CONTEXT_PTR ctx, EParameterName name, unsigned char *val, int sz)
| Записать в контекст значение параметра в виде последовательности байт. Подробнее...
PILOT_NT_API int | ctxGetString (CONTEXT_PTR ctx, EParameterName name, char *str, int sz)
| Считать из контекста значение переменной в виде строки. Подробнее...
PILOT_NT_API int | ctxGetInt (CONTEXT_PTR ctx, EParameterName name, int *pVal)
| Считать из контекста значение переменной в виде целого числа. Подробнее...
PILOT_NT_API int | ctxGetBinary (CONTEXT_PTR ctx, EParameterName name, unsigned char *pVal, int *pOutSz, int MAXSIZE)
| Считать из контекста значение переменной в виде последовательности байт. Подробнее...
PILOT_NT_API int | ShowQrCodeDisplay (char *pQrCode)
| Показать на дисплее терминала URL в виде QR-CODE. Подробнее...

## Подробное описание

## Функции

PILOT_NT_API CONTEXT_PTR ctxAlloc | ( | void |  | ) |

Создать контекст операции. Функция создает пустой контекст операции.

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

Возвращает
  CONTEXT_PTR Идентификатор контекста операции или 0, если произошла ошибка

PILOT_NT_API void ctxClear | ( | CONTEXT_PTR | ctx | ) |

Отчистить контекст. Функция удаляет все параметры из контекста.

Аргументы

  [in] | ctx | Идентификатор контекста.

Возвращает
  нет

PILOT_NT_API void ctxFree | ( | CONTEXT_PTR | ctx | ) |

Удалить контекст операции

Аргументы

  [in] | ctx | Идентификатор контекста.

Возвращает
  нет

PILOT_NT_API int ctxGetBinary | ( | CONTEXT_PTR | ctx,
|  | EParameterName | name,
|  | unsigned char * | pVal,
|  | int * | pOutSz,
|  | int | MAXSIZE
| ) |  |

Считать из контекста значение переменной в виде последовательности байт.

Заметки
  Для строковой переменной будет значение будет возвращено без изменения, для целочисленной переменной функция вернет последовательность из четырех байт с прямым порядком байт. Если размер буфера недостачен, в переменную pVal будет скопировано MAXSIZE байт, а вызов завершится ошибкой ERR_CTX_GET.

Аргументы

  [in] | ctx | Идентификатор контекста.
  [in] | name | Идентификатор параметра.
  [in] | pVal | Указатель на буфер результата.
  [in] | pOutSz | Количество байт, скопированных в буфер.
  [in] | MAXSIZE | Максимально возможное количество байт.

Возвращает
  int Код ошибки. ERR_OK - переменная считана успешно. ERR_CTX_GET - ошибка получения переменной.

PILOT_NT_API int ctxGetInt | ( | CONTEXT_PTR | ctx,
|  | EParameterName | name,
|  | int * | pVal
| ) |  |

Считать из контекста значение переменной в виде целого числа.

Заметки
  Для строковой переменной будет выполнено преобразование строки в число, для последовательности байт функция преобразует первые четыре байта последовательности в целое число с прямым порядком байт. При возвращении ошибки значение *pVal не изменяется

Аргументы

  [in] | ctx | Идентификатор контекста.
  [in] | name | Идентификатор параметра.
  [in] | pVal | Указатель на число.

Возвращает
  int Код ошибки. ERR_OK - переменная считана успешно. ERR_CTX_GET - ошибка получения переменной.

PILOT_NT_API int ctxGetString | ( | CONTEXT_PTR | ctx,
|  | EParameterName | name,
|  | char * | str,
|  | int | sz
| ) |  |

Считать из контекста значение переменной в виде строки.

Заметки
  Для целочисленной переменной вы получите ее строковое представление, а для последовательности байт функция вернет hex строку. Если размер буфера недостачен, в переменную pVal будет скопировано sz-1 байт + завершающий ноль, а вызов завершится ошибкой ERR_CTX_GET.

Аргументы

  [in] | ctx | Идентификатор контекста.
  [in] | name | Идентификатор параметра.
  [in] | val | Указатель на строку.
  [in] | sz | Максимально возможная длина строки.

Возвращает
  int Код ошибки.

PILOT_NT_API int ctxSetBinary | ( | CONTEXT_PTR | ctx,
|  | EParameterName | name,
|  | unsigned char * | val,
|  | int | sz
| ) |  |

Записать в контекст значение параметра в виде последовательности байт.

Аргументы

  [in] | ctx | Идентификатор контекста.
  [in] | name | Идентификатор параметра.
  [in] | val | Указатель на буфер.
  [in] | sz | Длина буфера.

Возвращает
  int Код ошибки.

PILOT_NT_API int ctxSetInt | ( | CONTEXT_PTR | ctx,
|  | EParameterName | name,
|  | int | val
| ) |  |

Записать в контекст значение целочисленного параметра.

Аргументы

  [in] | ctx | Идентификатор контекста.
  [in] | name | Идентификатор параметра.
  [in] | val | Значение параметра.

Возвращает
  int Код ошибки.

PILOT_NT_API int ctxSetString | ( | CONTEXT_PTR | ctx,
|  | EParameterName | name,
|  | const char * | str
| ) |  |

Записать в контекст значение строкового параметра.

Аргументы

  [in] | ctx | Идентификатор контекста.
  [in] | name | Идентификатор параметра.
  [in] | str | Указатель на строку.

Возвращает
  int Код ошибки.

PILOT_NT_API int ShowQrCodeDisplay | ( | char * | pQrCode | ) |

Показать на дисплее терминала URL в виде QR-CODE.

Аргументы

  [in] | pQrCode | URL Сбербанка должен начинаться с https://sberbank.ru/qr/.
  [out] | нет. |

Возвращает
  int Код ошибки.