System i: Programming Secure Sockets APIs - IBM

#include
int gsk_environment_open(gsk_handle *my_env_handle);
Service Program Name: QSYS/QSOSSLSR
Default Public Authority: *USE
Threadsafe: Yes
The gsk_environment_open() function is used to get storage for the SSL environment. This function call
must be issued before any other gsk function calls are issued. This call returns an SSL environment
handle that must be saved and used on subsequent gsk calls.
Parameters
my_env_handle (Output)
A pointer to the SSL environment handle to be used for subsequent gsk function calls.
Authorities
No authorization is required.
Return Value
gsk_environment_open() returns an integer. Possible values are:
[GSK_OK]
gsk_environment_open() was successful.
[GSK_API_NOT_AVAILABLE]
Digital Certificate Manager (DCM), 57xx-SS1 - OS400 Option 34 is not installed.
[GSK_INSUFFICIENT_STORAGE]
Not able to allocate storage for the requested operation.
[GSK_INTERNAL_ERROR]
An internal error occured during system processing.
[GSK_AS400_ERROR_INVALID_POINTER]
The my_env_handle pointer is not valid.
Error Messages
Message ID Error Message Text
CPE3418 E Possible APAR condition or hardware failure.
CPF9872 E Program or service program &1 in library &2 ended. Reason code &3.
CPFA081 E Unable to set return value or error code.
Usage Notes
1. After gsk_environment_open() returns with a GSK_OK return value, attributes for the SSL
environment have been set and can be retrieved using any of the get function calls. The following is a
list of the defaulted values:
v GSK_V2_SESSION_TIMEOUT set to 100 seconds.
v GSK_V3_SESSION_TIMEOUT set to 86400 seconds (24 hours).
v GSK_HANDSHAKE_TIMEOUT set to 0 (wait forever).
v GSK_OS400_RECEIVE_TIMEOUT set to 0 (wait forever).
Secure Sockets APIs 35