Cryptographic Error Functions

This section details the functions that enable the extraction of detailed error information after an error has occurred in the cryptographic module.

Functions
int	R_CR_get_error (R_CR crypto, int data)
	Returns the code of the last error that occurred in a cryptographic operation. More...
int	R_CR_get_reason (R_CR crypto, int data)
	Returns the reason code of the last error that occurred in a cryptographic operation. More...
int	R_CR_get_detail (R_CR crypto, int data)
	Returns the detail code of the last error that occurred in a cryptographic operation. More...
int	R_CR_get_function (R_CR crypto, int data)
	Returns the code for the function where the last error occurred. More...
int	R_CR_get_line (R_CR crypto, int data)
	Returns the line number of the file containing the function where the last error in a cryptographic operation occurred. More...
int	R_CR_get_file (R_CR crypto, char *data)
	Returns the name of the file containing the function where the last error in a cryptographic operation occurred. More...
int	R_CR_get_error_string (R_CR crypto, char *data)
	Returns the textual description of the last error that occurred in a cryptographic operation. More...
int	R_CR_get_reason_string (R_CR crypto, char *data)
	Returns the textual description of the reason code of the last error that occurred in a cryptographic operation. More...
int	R_CR_get_detail_string (R_CR crypto, char *data)
	Returns the textual description of the detail code of the last error that occurred in a cryptographic operation. More...
int	R_CR_get_function_string (R_CR crypto, char *data)
	Returns the textual description of the function where the last error occurred. More...

Function Documentation

int R_CR_get_detail ( R_CR * crypto,

int * data

) ;

Returns the detail code of the last error that occurred in a cryptographic operation.
Parameters:

crypto [In] A pointer to the cryptographic object.

data [Out] The address of the integer that takes the result.

Returns:
R_ERROR_NONE indicates success.
See Error Identifiers for valid values.
See also:
R_CR_get_error(), R_CR_get_reason(), R_CR_get_function(), R_CR_get_file(), R_CR_get_line(), R_CR_get_error_string(), R_CR_get_reason_string(), R_CR_get_detail_string(), R_CR_get_function_string(), Detail String Table and Error Detail Identifiers.

int R_CR_get_detail_string ( R_CR * crypto,

char ** data

) ;

Returns the textual description of the detail code of the last error that occurred in a cryptographic operation.
Parameters:

crypto [In] A pointer to the cryptographic object.

data [Out] The address of a pointer to the character that takes the result.

Returns:
R_ERROR_NONE indicates success.
See Error Identifiers for valid values.
Note:
The cryptographic module must have a loaded error string table, which contains descriptions of error reasons specific to the module.
Load the string table via an entry in the library context resource list.
See also:
R_CR_get_error(), R_CR_get_reason(), R_CR_get_detail(), R_CR_get_function(), R_CR_get_file(), R_CR_get_line(), R_CR_get_error_string(), R_CR_get_reason_string(), R_CR_get_function_string(), Detail String Table, Error Detail Identifiers, Resource List Module and Cryptographic Resource Definitions.

int R_CR_get_error ( R_CR * crypto,

int * data

) ;

Returns the code of the last error that occurred in a cryptographic operation.
Parameters:

crypto [In] A pointer to the cryptographic object.

data [Out] The address of the integer that takes the result.

Returns:
R_ERROR_NONE indicates success.
See Error Identifiers for valid values.
See also:
R_CR_get_reason(), R_CR_get_detail(), R_CR_get_function(), R_CR_get_file(), R_CR_get_line(), R_CR_get_error_string(), R_CR_get_reason_string(), R_CR_get_detail_string(), R_CR_get_function_string(), Function String Table, Public Function Identifiers, Method Function Identifiers, Internal Function Identifiers, Reason String Table, Error Reason Identifiers, Detail String Table and Error Detail Identifiers.

int R_CR_get_error_string ( R_CR * crypto,

char ** data

) ;

Returns the textual description of the last error that occurred in a cryptographic operation.
Parameters:

crypto [In] A pointer to the cryptographic object.

data [Out] The address of a pointer to the character that takes the result.

Returns:
R_ERROR_NONE indicates success.
See Error Identifiers for valid values.
Note:
The cryptographic module must have a loaded error string table, which contains descriptions of error reasons specific to the module.
Load the string table via an entry in the library context resource list.
See also:
R_CR_get_error(), R_CR_get_reason(), R_CR_get_detail(), R_CR_get_function(), R_CR_get_file(), R_CR_get_line(), R_CR_get_reason_string(), R_CR_get_detail_string() and R_CR_get_function_string().

int R_CR_get_file ( R_CR * crypto,

char ** data

) ;

Returns the name of the file containing the function where the last error in a cryptographic operation occurred.
Parameters:

crypto [In] A pointer to the cryptographic object.

data [Out] The address of the buffer that takes the result.

Returns:
R_ERROR_NONE indicates success.
See Error Identifiers for valid values.
See also:
R_CR_get_error(), R_CR_get_reason(), R_CR_get_detail(), R_CR_get_function(), R_CR_get_line(), R_CR_get_error_string(), R_CR_get_reason_string(), R_CR_get_detail_string() and R_CR_get_function_string().

int R_CR_get_function ( R_CR * crypto,

int * data

) ;

Returns the code for the function where the last error occurred.
Parameters:

crypto [In] A pointer to the cryptographic object.

data [Out] The address of the integer that takes the result.

Returns:
R_ERROR_NONE indicates success.
See Error Identifiers for valid values.
See also:
R_CR_get_error(), R_CR_get_reason(), R_CR_get_detail(), R_CR_get_file(), R_CR_get_line(), R_CR_get_error_string(), R_CR_get_reason_string(), R_CR_get_detail_string(), R_CR_get_function_string(), Function String Table, Public Function Identifiers, Method Function Identifiers and Internal Function Identifiers.

int R_CR_get_function_string ( R_CR * crypto,

char ** data

) ;

Returns the textual description of the function where the last error occurred.
Parameters:

crypto [In] A pointer to the cryptographic object.

data [Out] The address of a pointer to the character that takes the result.

Returns:
R_ERROR_NONE indicates success.
See Error Identifiers for valid values.
Note:
The cryptographic module must have a loaded error string table, which contains descriptions of error reasons specific to the module.
Load the string table via an entry in the library context resource list.
See also:
R_CR_get_error(), R_CR_get_reason(), R_CR_get_detail(), R_CR_get_function(), R_CR_get_file(), R_CR_get_line(), R_CR_get_error_string(), R_CR_get_reason_string(), R_CR_get_detail_string(), Function String Table, Public Function Identifiers, Method Function Identifiers, Internal Function Identifiers, Resource List Module and Cryptographic Resource Definitions.

int R_CR_get_line ( R_CR * crypto,

int * data

) ;

Returns the line number of the file containing the function where the last error in a cryptographic operation occurred.
Parameters:

crypto [In] A pointer to the cryptographic object.

data [Out] The address of the integer that takes the result.

Returns:
R_ERROR_NONE indicates success.
See Error Identifiers for valid values.
See also:
R_CR_get_error(), R_CR_get_reason(), R_CR_get_detail(), R_CR_get_function(), R_CR_get_file(), R_CR_get_error_string(), R_CR_get_reason_string(), R_CR_get_detail_string() and R_CR_get_function_string().

int R_CR_get_reason ( R_CR * crypto,

int * data

) ;

Returns the reason code of the last error that occurred in a cryptographic operation.
Parameters:

crypto [In] A pointer to the cryptographic object.

data [Out] The address of the integer that takes the result.

Returns:
R_ERROR_NONE indicates success.
See Error Identifiers for valid values.
See also:
R_CR_get_error(), R_CR_get_detail(), R_CR_get_function(), R_CR_get_file(), R_CR_get_line(), R_CR_get_error_string(), R_CR_get_reason_string(), R_CR_get_detail_string(), R_CR_get_function_string(), Reason String Table and Error Reason Identifiers.

int R_CR_get_reason_string ( R_CR * crypto,

char ** data

) ;

Returns the textual description of the reason code of the last error that occurred in a cryptographic operation.
Parameters:

crypto [In] A pointer to the cryptographic object.

data [Out] The address of a pointer to the character that takes the result.

Returns:
R_ERROR_NONE indicates success.
See Error Identifiers for valid values.
Note:
The cryptographic module must have a loaded error string table, which contains descriptions of error reasons specific to the module.
Load the string table via an entry in the library context resource list.
See also:
R_CR_get_error(), R_CR_get_reason(), R_CR_get_detail(), R_CR_get_function(), R_CR_get_file(), R_CR_get_line(), R_CR_get_error_string(), R_CR_get_detail_string(), R_CR_get_function_string(), Reason String Table, Error Reason Identifiers, Resource List Module and Cryptographic Resource Definitions.