Top |
Description
Most library functions uses an int return value to indicate success
or failure, using pskc_rc values. The values can be converted
into human readable explanations using pskc_strerror()
. The
symbolic error codes can be converted into strings using
pskc_strerror_name()
.
Functions
pskc_strerror ()
const char *
pskc_strerror (int err
);
Convert return code to human readable string explanation of the reason for the particular error code.
This string can be used to output a diagnostic message to the user.
This function is one of few in the library that can be used without
a successful call to pskc_init()
.
pskc_strerror_name ()
const char *
pskc_strerror_name (int err
);
Convert return code to human readable string representing the error
code symbol itself. For example, pskc_strerror_name(PSKC_OK
)
returns the string "PSKC_OK".
This string can be used to output a diagnostic message to the user.
This function is one of few in the library that can be used without
a successful call to pskc_init()
.
Types and Values
enum pskc_rc
Return codes for PSKC functions. All return codes are negative
except for the successful code PSKC_OK
which are guaranteed to be
Positive values are reserved for non-error return codes.
Note that the pskc_rc enumeration may be extended at a later date to include new return codes.