z/OS Cryptographic Services System SSL Programming
Previous topic | Next topic | Contents | Contact z/OS | Library | PDF


gsk_get_update()

z/OS Cryptographic Services System SSL Programming
SC14-7495-00

Checks for a key database, SAF key ring or z/OS® PKCS #11 token update.

Format

   #include <gskssl.h>

   gsk_status gsk_get_update (
                               gsk_handle     env_handle,
                               long *         update_flag)

Parameters

env_handle
Specifies the SSL environment handle returned by the gsk_environment_open() routine.
update_flag
Returns 1 if the key database, SAF key ring or z/OS PKCS #11 token has been updated or 0 if it has not been updated.

Results

The function return value will be 0 (GSK_OK) if no error is detected. Otherwise, it will be one of the return codes listed in the gskssl.h include file. These are some possible errors:
[GSK_INVALID_HANDLE]
The environment handle is not valid.
[GSK_INVALID_STATE]
The environment is not in the initialized state.
[GSK_KEYRING_OPEN_ERROR]
The key ring or token cannot be accessed.

Usage

The gsk_get_update() routine tests if the key database, SAF key ring or z/OS PKCS #11 token associated with the SSL environment has been updated since the last time that gsk_get_update() was called or since the environment was initialized if gsk_get_update() has not been called yet. If an update has occurred, the application can close the current environment and then create a new environment to pick up the updates.

Related Topics

gsk_environment_open()

Go to the previous page Go to the next page




Copyright IBM Corporation 1990, 2014