diff options
author | schwarze <> | 2016-11-02 15:23:41 +0000 |
---|---|---|
committer | schwarze <> | 2016-11-02 15:23:41 +0000 |
commit | 878e440382fa65ddbadca1d2784ef1210f0ff652 (patch) | |
tree | d746bbb5cfe6d085f48965873fc3db01fe55f4d6 /src/lib/libcrypto/doc/ERR_get_error.pod | |
parent | 0f15bae599b571173b77a87f7c4949ff89c55a23 (diff) | |
download | openbsd-878e440382fa65ddbadca1d2784ef1210f0ff652.tar.gz openbsd-878e440382fa65ddbadca1d2784ef1210f0ff652.tar.bz2 openbsd-878e440382fa65ddbadca1d2784ef1210f0ff652.zip |
convert ERR manuals from pod to mdoc; while reading this,
i wtfed, laughed, puked, and cried in more or less that order...
Diffstat (limited to 'src/lib/libcrypto/doc/ERR_get_error.pod')
-rw-r--r-- | src/lib/libcrypto/doc/ERR_get_error.pod | 79 |
1 files changed, 0 insertions, 79 deletions
diff --git a/src/lib/libcrypto/doc/ERR_get_error.pod b/src/lib/libcrypto/doc/ERR_get_error.pod deleted file mode 100644 index 460a79f3f6..0000000000 --- a/src/lib/libcrypto/doc/ERR_get_error.pod +++ /dev/null | |||
@@ -1,79 +0,0 @@ | |||
1 | =pod | ||
2 | |||
3 | =head1 NAME | ||
4 | |||
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_last_error_line_data - obtain error code and data | ||
9 | |||
10 | =head1 SYNOPSIS | ||
11 | |||
12 | #include <openssl/err.h> | ||
13 | |||
14 | unsigned long ERR_get_error(void); | ||
15 | unsigned long ERR_peek_error(void); | ||
16 | unsigned long ERR_peek_last_error(void); | ||
17 | |||
18 | unsigned long ERR_get_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); | ||
21 | |||
22 | unsigned long ERR_get_error_line_data(const char **file, int *line, | ||
23 | const char **data, int *flags); | ||
24 | unsigned long ERR_peek_error_line_data(const char **file, int *line, | ||
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); | ||
28 | |||
29 | =head1 DESCRIPTION | ||
30 | |||
31 | ERR_get_error() returns the earliest error code from the thread's error | ||
32 | queue and removes the entry. This function can be called repeatedly | ||
33 | until there are no more error codes to return. | ||
34 | |||
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 | ||
39 | error queue without modifying it. | ||
40 | |||
41 | See L<ERR_GET_LIB(3)|ERR_GET_LIB(3)> for obtaining information about | ||
42 | location and reason of the error, and | ||
43 | L<ERR_error_string(3)|ERR_error_string(3)> for human-readable error | ||
44 | messages. | ||
45 | |||
46 | ERR_get_error_line(), ERR_peek_error_line() and | ||
47 | ERR_peek_last_error_line() are the same as the above, but they | ||
48 | additionally store the file name and line number where | ||
49 | the error occurred in *B<file> and *B<line>, unless these are B<NULL>. | ||
50 | |||
51 | ERR_get_error_line_data(), ERR_peek_error_line_data() and | ||
52 | ERR_peek_last_error_line_data() store additional data and flags | ||
53 | associated with the error code in *B<data> | ||
54 | and *B<flags>, unless these are B<NULL>. *B<data> contains a string | ||
55 | if *B<flags>&B<ERR_TXT_STRING> is true. | ||
56 | |||
57 | An application B<MUST NOT> free the *B<data> pointer (or any other pointers | ||
58 | returned by these functions) with free() as freeing is handled | ||
59 | automatically by the error library. | ||
60 | |||
61 | =head1 RETURN VALUES | ||
62 | |||
63 | The error code, or 0 if there is no error in the queue. | ||
64 | |||
65 | =head1 SEE ALSO | ||
66 | |||
67 | L<err(3)|err(3)>, L<ERR_error_string(3)|ERR_error_string(3)>, | ||
68 | L<ERR_GET_LIB(3)|ERR_GET_LIB(3)> | ||
69 | |||
70 | =head1 HISTORY | ||
71 | |||
72 | ERR_get_error(), ERR_peek_error(), ERR_get_error_line() and | ||
73 | ERR_peek_error_line() are available in all versions of SSLeay and | ||
74 | OpenSSL. ERR_get_error_line_data() and ERR_peek_error_line_data() | ||
75 | were added in SSLeay 0.9.0. | ||
76 | ERR_peek_last_error(), ERR_peek_last_error_line() and | ||
77 | ERR_peek_last_error_line_data() were added in OpenSSL 0.9.7. | ||
78 | |||
79 | =cut | ||