Blame doc/man3/ERR_load_strings.pod
|
Packit |
c4476c |
=pod
|
|
Packit |
c4476c |
|
|
Packit |
c4476c |
=head1 NAME
|
|
Packit |
c4476c |
|
|
Packit |
c4476c |
ERR_load_strings, ERR_PACK, ERR_get_next_error_library - load
|
|
Packit |
c4476c |
arbitrary error strings
|
|
Packit |
c4476c |
|
|
Packit |
c4476c |
=head1 SYNOPSIS
|
|
Packit |
c4476c |
|
|
Packit |
c4476c |
#include <openssl/err.h>
|
|
Packit |
c4476c |
|
|
Packit |
c4476c |
void ERR_load_strings(int lib, ERR_STRING_DATA str[]);
|
|
Packit |
c4476c |
|
|
Packit |
c4476c |
int ERR_get_next_error_library(void);
|
|
Packit |
c4476c |
|
|
Packit |
c4476c |
unsigned long ERR_PACK(int lib, int func, int reason);
|
|
Packit |
c4476c |
|
|
Packit |
c4476c |
=head1 DESCRIPTION
|
|
Packit |
c4476c |
|
|
Packit |
c4476c |
ERR_load_strings() registers error strings for library number B<lib>.
|
|
Packit |
c4476c |
|
|
Packit |
c4476c |
B<str> is an array of error string data:
|
|
Packit |
c4476c |
|
|
Packit |
c4476c |
typedef struct ERR_string_data_st
|
|
Packit |
c4476c |
{
|
|
Packit |
c4476c |
unsigned long error;
|
|
Packit |
c4476c |
char *string;
|
|
Packit |
c4476c |
} ERR_STRING_DATA;
|
|
Packit |
c4476c |
|
|
Packit |
c4476c |
The error code is generated from the library number and a function and
|
|
Packit |
c4476c |
reason code: B<error> = ERR_PACK(B<lib>, B<func>, B<reason>).
|
|
Packit |
c4476c |
ERR_PACK() is a macro.
|
|
Packit |
c4476c |
|
|
Packit |
c4476c |
The last entry in the array is {0,0}.
|
|
Packit |
c4476c |
|
|
Packit |
c4476c |
ERR_get_next_error_library() can be used to assign library numbers
|
|
Packit |
c4476c |
to user libraries at runtime.
|
|
Packit |
c4476c |
|
|
Packit |
c4476c |
=head1 RETURN VALUES
|
|
Packit |
c4476c |
|
|
Packit |
c4476c |
ERR_load_strings() returns no value. ERR_PACK() return the error code.
|
|
Packit |
c4476c |
ERR_get_next_error_library() returns zero on failure, otherwise a new
|
|
Packit |
c4476c |
library number.
|
|
Packit |
c4476c |
|
|
Packit |
c4476c |
=head1 SEE ALSO
|
|
Packit |
c4476c |
|
|
Packit |
c4476c |
L<ERR_load_strings(3)>
|
|
Packit |
c4476c |
|
|
Packit |
c4476c |
=head1 COPYRIGHT
|
|
Packit |
c4476c |
|
|
Packit |
c4476c |
Copyright 2000-2018 The OpenSSL Project Authors. All Rights Reserved.
|
|
Packit |
c4476c |
|
|
Packit |
c4476c |
Licensed under the OpenSSL license (the "License"). You may not use
|
|
Packit |
c4476c |
this file except in compliance with the License. You can obtain a copy
|
|
Packit |
c4476c |
in the file LICENSE in the source distribution or at
|
|
Packit |
c4476c |
L<https://www.openssl.org/source/license.html>.
|
|
Packit |
c4476c |
|
|
Packit |
c4476c |
=cut
|