abcrypt_error_message(3)

NAME

abcrypt_error_message - API function

SYNOPSIS

#include <abcrypt.h>

enum abcrypt_error_code abcrypt_error_message(enum abcrypt_error_code error_code,
                                              uint8_t *buf,
                                              uintptr_t buf_len);

DESCRIPTION

This function gets a detailed error message.

Arguments

error_code: An error value defined in abcrypt_error_code(3).
buf: A pointer to the buffer to write the error message to.
buf_len: Length of buf.

Behavior is undefined if buf or buf_len is invalid.

RETURN VALUE

Returns ABCRYPT_ERROR_CODE_OK if successful, otherwise returns an error value defined in abcrypt_error_code(3).

VERSIONS

This function was added in version 0.1.0.

REPORTING BUGS

Report bugs to:: https://github.com/sorairolake/abcrypt/issues

COPYRIGHT

This manual page is distributed under the terms of the Creative Commons Attribution 4.0 International Public License.