gsk_attribute_get_numeric

Gets a numeric value.

Format

   #include <gskssl.h>

   gsk_status gsk_attribute_get_numeric_value (
                                                gsk_handle     ssl_handle,
                                                GSK_NUM_ID     num_id,
                                                int *          num_value)

Parameters

ssl_handle: Specifies an SSL environment handle returned by gsk_environment_open() or an SSL connection handle returned by gsk_secure_socket_open().
num_id: Specifies the numeric identifier.
num_value: Returns the numeric value.

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_ATTRIBUTE_INVALID_ID]: The numeric identifier is not valid or cannot be used with the specified handle.
[GSK_INVALID_HANDLE]: The handle is not valid.
[GSK_INVALID_STATE]: The environment is closed.

Usage

The gsk_attribute_get_numeric_value() routine will return a numeric value for an SSL environment or an SSL connection.

These numeric identifiers are supported:

GSK_CRL_CACHE_TIMEOUT: Returns the CRL cache timeout. GSK_CRL_CACHE_TIMEOUT can be specified only for an SSL environment.
GSK_FD: Returns the socket descriptor used for network operations. GSK_FD can be specified only for an SSL connection.
GSK_LDAP_SERVER_PORT: Returns the LDAP server port. GSK_LDAP_SERVER_PORT can be specified only for an SSL environment.
GSK_V2_SESSION_TIMEOUT: Returns the SSL Version 2 session timeout. GSK_V2_SESSION_TIMEOUT can be specified only for an SSL environment.
GSK_V2_SIDCACHE_SIZE: Returns the size of the SSL Version 2 session identifier cache. GSK_V2_SIDCACHE_SIZE can be specified only for an SSL environment.
GSK_V3_SESSION_TIMEOUT: Returns the SSL Version 3 session timeout. GSK_V3_SESSION_TIMEOUT can be specified only for an SSL environment.
GSK_V3_SIDCACHE_SIZE: Returns the size of the SSL Version 3 session identifier cache. GSK_V3_SIDCACHE_SIZE can be specified only for an SSL environment.

Format

Parameters

Results

Usage

Related Topics