gsk_strerror()--Retrieve GSKit runtime error message

 #include <gskssl.h>

 const char *gsk_strerror(int gsk_return_value);  
 

The gsk_strerror() function is used to retrieve an error message and associated text string that describes a return value that was returned from calling a GSKit API.

Parameters

gsk_return_value (Input) 

The return value received from a GSKit API.

Authorities

No authorization is required.

Return Value

gsk_strerror() returns a pointer to the return value text.

Usage Notes

1. gsk_strerror() returns a pointer to the string. The null-terminated string is stored in the CCSID of the job.
   
   
2. If a gsk_return_value is specified for which there is no corresponding description, an Unknown Error string is returned.

Related Information

• gsk_attribute_get_buffer()--Get character information about a secure session or an SSL environment.
  
  
• gsk_attribute_get_cert_info()--Get information about a local or partner certificate.
  
  
• gsk_attribute_get_enum()--Get enumerated information about a secure session or an SSL environment.
  
  
• gsk_attribute_get_numeric_value()--Get numeric information about a secure session or an SSL environment.
  
  
• gsk_attribute_set_buffer()--Set character information for a secure session or an SSL environment.
  
  
• gsk_attribute_set_enum()--Set enumerated information for a secure session or an SSL environment.
  
  
• gsk_attribute_set_numeric_value()--Set numeric information for a secure session or an SSL environment
  
  
• gsk_environment_close()--Close the SSL environment
  
  
• gsk_environment_init()--Initialize a SSL environment
  
  
• gsk_environment_open()--Get a handle for an SSL environment
  
  
• gsk_secure_soc_close()--Close a secure session
  
  
• gsk_secure_soc_init()--Negotiate a secure session
  
  
• gsk_secure_soc_misc()--Perform miscellaneous functions for a secure session
  
  
• gsk_secure_soc_open()--Get a handle for a secure session
  
  
• gsk_secure_soc_read()--Receive data on a secure session
  
  
• gsk_secure_soc_write()--Send data on a secure session

Example

See Code disclaimer information for information pertaining to code examples.

The following example shows how gsk_strerror() is used:

#include <stdio.h>
#include <sys/types.h>
#include <gskssl.h>     

void main()
{
  int rc = GSK_OK; 
  gsk_handle env_handle = NULL;

  rc = gsk_environment_open(&env_handle);
  if (rc != GSK_OK)
  {
    printf("gsk_environment_open() failed with rc = %d %s\n",
            rc,gsk_strerror(rc));
    break;
  }                          

  ...

}