Служебные функции

USB-токены и смарт-карты JaCartaAPI и SDKUSB-токены и смарт-карты JaCarta

C_Initialize

CK_RV C_Initialize(CK_VOID_PTR * pInitArgs*)

Инициализирует библиотеку. pInitArgs либо принимает значение NULL_PTR, либо содержит указатель на структуру типа CK_C_INITIALIZE_ARGS.

Параметры:

pInitArgs (in) – указатель на структуру типа CK_C_INITIALIZE_ARGS.

Запускается в режимах:

Результат:

CKR_ARGUMENTS_BAD – недопустимые аргументы.
CKR_CANT_LOCK – невозможно использовать разделение ресурсов.
CKR_CRYPTOKI_ALREADY_INITIALIZED – библиотека уже была инициализирована вызовом C_Initialize и не была закрыта соответствующим вызовом C_Finalize().
CKR_FUNCTION_FAILED – выполнение функции было прервано или она не может быть выполнена.
CKR_GENERAL_ERROR – общий сбой при работе с библиотекой.
CKR_HOST_MEMORY – компьютер, на котором запущена библиотека, не имеет достаточно памяти для выполнения функции.
CKR_OK – функция выполнена успешно.

C_Finalize

CK_RV C_Finalize(CK_VOID_PTR pReserved)

C_Finalize вызывается для окончания сеанса использования приложением библиотеки. При выполнении освобождает память, выделенную другим функциям (аналогично вызову функции freeBuffer() для каждого выделенного буфера памяти). Эта функция должна быть последним вызовом в сеансе.

Параметры:

pReserved (out) – данный параметр предназначен для последующих версий PKCS #11. Должен содержать значение NULL_PTR.

Запускается в режимах:

Результат:

CKR_ARGUMENTS_BAD – недопустимые аргументы. Возвращается в случае, если pReserved не равен NULL_PTR.
CKR_CRYPTOKI_NOT_INITIALIZED – функция не может быть выполнена, т.к. библиотека еще не была инициализирована (см. C_Initialize()).
CKR_FUNCTION_FAILED – выполнение функции было прервано или она не может быть выполнена.
CKR_GENERAL_ERROR – общий сбой при работе с библиотекой.
CKR_HOST_MEMORY – компьютер, на котором запущена библиотека, не имеет достаточно памяти для выполнения функции.
CKR_OK – функция выполнена успешно.

C_GetInfo

CK_RV C_GetInfo(CK_INFO_PTR pInfo)

Возвращает общую информацию о библиотеке, которая записывается в структуру типа CK_INFO.

Параметры:

pInfo (out) – указатель на структуру, в которую функция записывает сведения о библиотеке.

Запускается в режимах:

Результат:

CKR_ARGUMENTS_BAD – недопустимые аргументы.
CKR_CRYPTOKI_NOT_INITIALIZED – функция не может быть выполнена, т.к. библиотека еще не была инициализирована (см. C_Initialize()).
CKR_FUNCTION_FAILED – выполнение функции было прервано или она не может быть выполнена.
CKR_GENERAL_ERROR – общий сбой при работе с библиотекой.
CKR_HOST_MEMORY – компьютер, на котором запущена библиотека, не имеет достаточно памяти для выполнения функции.
CKR_OK – функция выполнена успешно.

`C_GetFunctionList`

CK_RV C_GetFunctionList(CK_FUNCTION_LIST_PTR_PTR ppFunctionList)

Метод для получения указателя на список указателей на все функции библиотеки. ppFunctionList содержит указатель на структуру CK_FUNCTION_LIST библиотеки, которая в свою очередь содержит указатели на все методы Cryptoki API.

Параметры:

ppFunctionList (out) – двойной указатель на структуру типа CK_FUNCTION_LIST, которая содержит указатели на все методы Cryptoki API.

Запускается в режимах:

Результат:

CKR_ARGUMENTS_BAD – недопустимые аргументы.
CKR_FUNCTION_FAILED – выполнение функции было прервано или она не может быть выполнена.
CKR_GENERAL_ERROR – общий сбой при работе с библиотекой.
CKR_HOST_MEMORY – компьютер, на котором запущена библиотека, не имеет достаточно памяти для выполнения функции.
CKR_OK – функция выполнена успешно.