diff options
Diffstat (limited to 'src/lib/libcrypto/doc/ERR_get_error.pod')
-rw-r--r-- | src/lib/libcrypto/doc/ERR_get_error.pod | 30 |
1 files changed, 22 insertions, 8 deletions
diff --git a/src/lib/libcrypto/doc/ERR_get_error.pod b/src/lib/libcrypto/doc/ERR_get_error.pod index 75ece00d97..9fdedbcb91 100644 --- a/src/lib/libcrypto/doc/ERR_get_error.pod +++ b/src/lib/libcrypto/doc/ERR_get_error.pod | |||
@@ -2,7 +2,10 @@ | |||
2 | 2 | ||
3 | =head1 NAME | 3 | =head1 NAME |
4 | 4 | ||
5 | ERR_get_error, ERR_peek_error - obtain error code | 5 | ERR_get_error, ERR_peek_error, ERR_peek_last_error, |
6 | ERR_get_error_line, ERR_peek_error_line, ERR_peek_last_error_line, | ||
7 | ERR_get_error_line_data, ERR_peek_error_line_data, | ||
8 | ERR_peek_error_line_data - obtain error code and data | ||
6 | 9 | ||
7 | =head1 SYNOPSIS | 10 | =head1 SYNOPSIS |
8 | 11 | ||
@@ -10,22 +13,29 @@ ERR_get_error, ERR_peek_error - obtain error code | |||
10 | 13 | ||
11 | unsigned long ERR_get_error(void); | 14 | unsigned long ERR_get_error(void); |
12 | unsigned long ERR_peek_error(void); | 15 | unsigned long ERR_peek_error(void); |
16 | unsigned long ERR_peek_last_error(void); | ||
13 | 17 | ||
14 | unsigned long ERR_get_error_line(const char **file, int *line); | 18 | unsigned long ERR_get_error_line(const char **file, int *line); |
15 | unsigned long ERR_peek_error_line(const char **file, int *line); | 19 | unsigned long ERR_peek_error_line(const char **file, int *line); |
20 | unsigned long ERR_peek_last_error_line(const char **file, int *line); | ||
16 | 21 | ||
17 | unsigned long ERR_get_error_line_data(const char **file, int *line, | 22 | unsigned long ERR_get_error_line_data(const char **file, int *line, |
18 | const char **data, int *flags); | 23 | const char **data, int *flags); |
19 | unsigned long ERR_peek_error_line_data(const char **file, int *line, | 24 | unsigned long ERR_peek_error_line_data(const char **file, int *line, |
20 | const char **data, int *flags); | 25 | const char **data, int *flags); |
26 | unsigned long ERR_peek_last_error_line_data(const char **file, int *line, | ||
27 | const char **data, int *flags); | ||
21 | 28 | ||
22 | =head1 DESCRIPTION | 29 | =head1 DESCRIPTION |
23 | 30 | ||
24 | ERR_get_error() returns the last error code from the thread's error | 31 | ERR_get_error() returns the earliest error code from the thread's error |
25 | queue and removes the entry. This function can be called repeatedly | 32 | queue and removes the entry. This function can be called repeatedly |
26 | until there are no more error codes to return. | 33 | until there are no more error codes to return. |
27 | 34 | ||
28 | ERR_peek_error() returns the last error code from the thread's | 35 | ERR_peek_error() returns the earliest error code from the thread's |
36 | error queue without modifying it. | ||
37 | |||
38 | ERR_peek_last_error() returns the latest error code from the thread's | ||
29 | error queue without modifying it. | 39 | error queue without modifying it. |
30 | 40 | ||
31 | See L<ERR_GET_LIB(3)|ERR_GET_LIB(3)> for obtaining information about | 41 | See L<ERR_GET_LIB(3)|ERR_GET_LIB(3)> for obtaining information about |
@@ -33,14 +43,16 @@ location and reason of the error, and | |||
33 | L<ERR_error_string(3)|ERR_error_string(3)> for human-readable error | 43 | L<ERR_error_string(3)|ERR_error_string(3)> for human-readable error |
34 | messages. | 44 | messages. |
35 | 45 | ||
36 | ERR_get_error_line() and ERR_peek_error_line() are the same as the | 46 | ERR_get_error_line(), ERR_peek_error_line() and |
37 | above, but they additionally store the file name and line number where | 47 | ERR_peek_last_error_line() are the same as the above, but they |
48 | additionally store the file name and line number where | ||
38 | the error occurred in *B<file> and *B<line>, unless these are B<NULL>. | 49 | the error occurred in *B<file> and *B<line>, unless these are B<NULL>. |
39 | 50 | ||
40 | ERR_get_error_line_data() and ERR_peek_error_line_data() store | 51 | ERR_get_error_line_data(), ERR_peek_error_line_data() and |
41 | additional data and flags associated with the error code in *B<data> | 52 | ERR_get_last_error_line_data() store additional data and flags |
53 | associated with the error code in *B<data> | ||
42 | and *B<flags>, unless these are B<NULL>. *B<data> contains a string | 54 | and *B<flags>, unless these are B<NULL>. *B<data> contains a string |
43 | if *B<flags>&B<ERR_TXT_STRING>. If it has been allocated by Malloc(), | 55 | if *B<flags>&B<ERR_TXT_STRING>. If it has been allocated by OPENSSL_malloc(), |
44 | *B<flags>&B<ERR_TXT_MALLOCED> is true. | 56 | *B<flags>&B<ERR_TXT_MALLOCED> is true. |
45 | 57 | ||
46 | =head1 RETURN VALUES | 58 | =head1 RETURN VALUES |
@@ -58,5 +70,7 @@ ERR_get_error(), ERR_peek_error(), ERR_get_error_line() and | |||
58 | ERR_peek_error_line() are available in all versions of SSLeay and | 70 | ERR_peek_error_line() are available in all versions of SSLeay and |
59 | OpenSSL. ERR_get_error_line_data() and ERR_peek_error_line_data() | 71 | OpenSSL. ERR_get_error_line_data() and ERR_peek_error_line_data() |
60 | were added in SSLeay 0.9.0. | 72 | were added in SSLeay 0.9.0. |
73 | ERR_peek_last_error(), ERR_peek_last_error_line() and | ||
74 | ERR_peek_last_error_line_data() were added in OpenSSL 0.9.7. | ||
61 | 75 | ||
62 | =cut | 76 | =cut |