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


gsk_environment_close()

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

Closes an SSL environment.

Format

   #include <gskssl.h>

   gsk_status gsk_environment_close (
                                      gsk_handle *     env_handle)

Parameters

env_handle
Specifies the SSL environment handle returned by the gsk_environment_open() routine. The environment handle will be set to NULL upon completion.

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 already closed.

Usage

The gsk_environment_close() routine closes an environment created by the gsk_environment_open() routine. The storage that is allocated for the environment is not released until all connections created using the environment are closed. The SSL environment cannot be used to create new connections upon completion of the close.

Related Topics

gsk_environment_open()

gsk_environment_init()

gsk_secure_socket_init()

gsk_secure_socket_close()

Parent topic: API reference

Go to the previous page Go to the next page

Notices | Terms of use | Support | Contact z/OS | zFavorites



Copyright IBM Corporation 1990, 2014