Функция espGetParamFn

Функция получения параметров SPI сессии и последнего декапсулированного пакета.

Синтаксис

C/C++

 capi_result CAPI_EXTC espGetParamFn (
   ESP_HANDLE sid,
   unsigned uFlags,
   unsigned uParam,
   void *pData,
   unsigned *puDataLen
 );

Параметры

sid: [in] Дескриптор SPI сессии

uFlags: [in] Зарезервировано для будущего использования. Должен быть равен 0

uParam

[in]

Значение uParam

Содержимое буфера pData

ESP_LENPARAMS

Возвращает длины полей синхровектора IV, ICV и значение выравнивания данных при инкапсуляции в структуре CPESP_LENPARAMS_T

struct CPESP_LENPARAMS_T {

unsigned IV_SIZE;

unsigned PAD_MODULE;

unsigned ICV_SIZE;

};

ESP_PACKETIMITA

Значение имитовставки пакета (внутренней для режима CPESP_GOST_1K_IMIT и значение имитовставки для режима CPESP_GOST_4M_IMIT).

ESP_MULTIPACKET_MAX

Максимальное количество пакетов, которое можно подать в espEncapFn и espDecapFn при использовании ESP_DATA_MULTIPACKET.

ESP_MULTIPACKET_OPT_KEY

Модуль, определяющий оптимальный диапазон номеров пакетов, которые будут обработаны на одном ключе в espEncapFn и espDecapFn для достижения максимальной производительности при использовании ESP_DATA_MULTIPACKET.

ESP_MULTIPACKET_OPT_KEY

Оптимальное количество пакетов в оптимальном диапазоне (см. ESP_MULTIPACKET_OPT_KEY), которое можно подать в espEncapFn и espDecapFn для достижения максимальной производительности при использовании ESP_DATA_MULTIPACKET.

Значение uParam	Содержимое буфера pData
ESP_LENPARAMS	Возвращает длины полей синхровектора IV, ICV и значение выравнивания данных при инкапсуляции в структуре CPESP_LENPARAMS_T struct CPESP_LENPARAMS_T { unsigned IV_SIZE; unsigned PAD_MODULE; unsigned ICV_SIZE; };
ESP_PACKETIMITA	Значение имитовставки пакета (внутренней для режима CPESP_GOST_1K_IMIT и значение имитовставки для режима CPESP_GOST_4M_IMIT).
ESP_MULTIPACKET_MAX	Максимальное количество пакетов, которое можно подать в espEncapFn и espDecapFn при использовании ESP_DATA_MULTIPACKET.
ESP_MULTIPACKET_OPT_KEY	Модуль, определяющий оптимальный диапазон номеров пакетов, которые будут обработаны на одном ключе в espEncapFn и espDecapFn для достижения максимальной производительности при использовании ESP_DATA_MULTIPACKET.
ESP_MULTIPACKET_OPT_KEY	Оптимальное количество пакетов в оптимальном диапазоне (см. ESP_MULTIPACKET_OPT_KEY), которое можно подать в espEncapFn и espDecapFn для достижения максимальной производительности при использовании ESP_DATA_MULTIPACKET.

pData: [in/out] Указатель на буфер данных параметра. Функция копирует соответствующие параметру данные в буфер. Формат этих данных зависит от значения uParam. Если параметр - NULL, то данные не копируются. Требуемый размер буфера в байтах возвращается в puDataLen.

puDataLen: [in/out] Указатель на буфер, содержащий длину данных параметра. При вызове функции указанный параметр содержит число байтов в буфере pData. После её исполнения параметр будет установлен числом байтов данных параметра, скопированных в буфер pData. Если буфер, соответствующий pData, недостаточно большой, чтобы в него копировать запрошенные данные, будет возвращен код ошибки CAPI_CALL_ERROR. В этом случае требуемый размер буфера возвращается в puDataLen.

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

CAPI_NOERROR Успешное завершение

CAPI_CALL_ERROR Неверные аргументы

Требования

Заголовочный файл	esp_gost.h
Библиотека
Минимальная версия продукта	1.0