diff options
| author | schwarze <> | 2016-11-02 15:23:41 +0000 |
|---|---|---|
| committer | schwarze <> | 2016-11-02 15:23:41 +0000 |
| commit | e555e2e6cc68ff074abb5f707eeb2bde15f9e8f0 (patch) | |
| tree | d746bbb5cfe6d085f48965873fc3db01fe55f4d6 /src/lib/libcrypto/man/ERR_put_error.3 | |
| parent | c5ef581eab94ca8726254ac45c1577ecde5adcac (diff) | |
| download | openbsd-e555e2e6cc68ff074abb5f707eeb2bde15f9e8f0.tar.gz openbsd-e555e2e6cc68ff074abb5f707eeb2bde15f9e8f0.tar.bz2 openbsd-e555e2e6cc68ff074abb5f707eeb2bde15f9e8f0.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/man/ERR_put_error.3')
| -rw-r--r-- | src/lib/libcrypto/man/ERR_put_error.3 | 58 |
1 files changed, 58 insertions, 0 deletions
diff --git a/src/lib/libcrypto/man/ERR_put_error.3 b/src/lib/libcrypto/man/ERR_put_error.3 new file mode 100644 index 0000000000..703b74d713 --- /dev/null +++ b/src/lib/libcrypto/man/ERR_put_error.3 | |||
| @@ -0,0 +1,58 @@ | |||
| 1 | .Dd $Mdocdate: November 2 2016 $ | ||
| 2 | .Dt ERR_PUT_ERROR 3 | ||
| 3 | .Os | ||
| 4 | .Sh NAME | ||
| 5 | .Nm ERR_put_error , | ||
| 6 | .Nm ERR_add_error_data | ||
| 7 | .Nd record an OpenSSL error | ||
| 8 | .Sh SYNOPSIS | ||
| 9 | .In openssl/err.h | ||
| 10 | .Ft void | ||
| 11 | .Fo ERR_put_error | ||
| 12 | .Fa "int lib" | ||
| 13 | .Fa "int func" | ||
| 14 | .Fa "int reason" | ||
| 15 | .Fa "const char *file" | ||
| 16 | .Fa "int line" | ||
| 17 | .Fc | ||
| 18 | .Ft void | ||
| 19 | .Fo ERR_add_error_data | ||
| 20 | .Fa "int num" | ||
| 21 | .Fa ... | ||
| 22 | .Fc | ||
| 23 | .Sh DESCRIPTION | ||
| 24 | .Fn ERR_put_error | ||
| 25 | adds an error code to the thread's error queue. | ||
| 26 | It signals that the error of reason code | ||
| 27 | .Fa reason | ||
| 28 | occurred in function | ||
| 29 | .Fa func | ||
| 30 | of library | ||
| 31 | .Fa lib , | ||
| 32 | in line number | ||
| 33 | .Fa line | ||
| 34 | of | ||
| 35 | .Fa file . | ||
| 36 | This function is usually called by a macro. | ||
| 37 | .Pp | ||
| 38 | .Fn ERR_add_error_data | ||
| 39 | associates the concatenation of its | ||
| 40 | .Fa num | ||
| 41 | string arguments with the error code added last. | ||
| 42 | .Pp | ||
| 43 | .Xr ERR_load_strings 3 | ||
| 44 | can be used to register error strings so that the application can a | ||
| 45 | generate human-readable error messages for the error code. | ||
| 46 | .Sh RETURN VALUES | ||
| 47 | .Fn ERR_put_error | ||
| 48 | and | ||
| 49 | .Fn ERR_add_error_data | ||
| 50 | return no values. | ||
| 51 | .Sh SEE ALSO | ||
| 52 | .Xr ERR 3 , | ||
| 53 | .Xr ERR_load_strings 3 | ||
| 54 | .Sh HISTORY | ||
| 55 | .Fn ERR_put_error | ||
| 56 | is available in all versions of SSLeay and OpenSSL. | ||
| 57 | .Fn ERR_add_error_data | ||
| 58 | was added in SSLeay 0.9.0. | ||
