3.\" 4.\" Standard preamble: 5.\" ====================================================================== 6.de Sh \" Subsection heading 7.br 8.if t .Sp 9.ne 5 10.PP 11\fB\\$1\fR 12.PP 13.. 14.de Sp \" Vertical space (when we can't use .PP) 15.if t .sp .5v 16.if n .sp 17.. 18.de Ip \" List item 19.br 20.ie \\n(.$>=3 .ne \\$3 21.el .ne 3 22.IP "\\$1" \\$2 23.. 24.de Vb \" Begin verbatim text 25.ft CW 26.nf 27.ne \\$1 28.. 29.de Ve \" End verbatim text 30.ft R 31 32.fi 33.. 34.\" Set up some character translations and predefined strings. \*(-- will 35.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left 36.\" double quote, and \*(R" will give a right double quote. | will give a 37.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used 38.\" to do unbreakable dashes and therefore won't be available. \*(C` and 39.\" \*(C' expand to `' in nroff, nothing in troff, for use with C<> 40.tr \(*W-|\(bv\*(Tr 41.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' 42.ie n \{\ 43. ds -- \(*W- 44. ds PI pi 45. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch 46. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch 47. ds L" "" 48. ds R" "" 49. ds C` "" 50. ds C' "" 51'br\} 52.el\{\ 53. ds -- \|\(em\| 54. ds PI \(*p 55. ds L" `` 56. ds R" '' 57'br\} 58.\" 59.\" If the F register is turned on, we'll generate index entries on stderr 60.\" for titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and 61.\" index entries marked with X<> in POD. Of course, you'll have to process 62.\" the output yourself in some meaningful fashion. 63.if \nF \{\ 64. de IX 65. tm Index:\\$1\t\\n%\t"\\$2" 66.. 67. nr % 0 68. rr F 69.\} 70.\" 71.\" For nroff, turn off justification. Always turn off hyphenation; it 72.\" makes way too many mistakes in technical documents. 73.hy 0 74.if n .na 75.\" 76.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). 77.\" Fear. Run. Save yourself. No user-serviceable parts. 78.bd B 3 79. \" fudge factors for nroff and troff 80.if n \{\ 81. ds #H 0 82. ds #V .8m 83. ds #F .3m 84. ds #[ \f1 85. ds #] \fP 86.\} 87.if t \{\ 88. ds #H ((1u-(\\\\n(.fu%2u))*.13m) 89. ds #V .6m 90. ds #F 0 91. ds #[ \& 92. ds #] \& 93.\} 94. \" simple accents for nroff and troff 95.if n \{\ 96. ds ' \& 97. ds ` \& 98. ds ^ \& 99. ds , \& 100. ds ~ ~ 101. ds / 102.\} 103.if t \{\ 104. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" 105. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' 106. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' 107. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' 108. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' 109. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' 110.\} 111. \" troff and (daisy-wheel) nroff accents 112.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' 113.ds 8 \h'\*(#H'\(*b\h'-\*(#H' 114.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] 115.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' 116.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' 117.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] 118.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] 119.ds ae a\h'-(\w'a'u*4/10)'e 120.ds Ae A\h'-(\w'A'u*4/10)'E 121. \" corrections for vroff 122.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' 123.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' 124. \" for low resolution devices (crt and lpr) 125.if \n(.H>23 .if \n(.V>19 \ 126\{\ 127. ds : e 128. ds 8 ss 129. ds o a 130. ds d- d\h'-1'\(ga 131. ds D- D\h'-1'\(hy 132. ds th \o'bp' 133. ds Th \o'LP' 134. ds ae ae 135. ds Ae AE 136.\} 137.rm #[ #] #H #V #F C 138.\" ====================================================================== 139.\" 140.IX Title "ERR_error_string 3"
| 3.\" 4.\" Standard preamble: 5.\" ====================================================================== 6.de Sh \" Subsection heading 7.br 8.if t .Sp 9.ne 5 10.PP 11\fB\\$1\fR 12.PP 13.. 14.de Sp \" Vertical space (when we can't use .PP) 15.if t .sp .5v 16.if n .sp 17.. 18.de Ip \" List item 19.br 20.ie \\n(.$>=3 .ne \\$3 21.el .ne 3 22.IP "\\$1" \\$2 23.. 24.de Vb \" Begin verbatim text 25.ft CW 26.nf 27.ne \\$1 28.. 29.de Ve \" End verbatim text 30.ft R 31 32.fi 33.. 34.\" Set up some character translations and predefined strings. \*(-- will 35.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left 36.\" double quote, and \*(R" will give a right double quote. | will give a 37.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used 38.\" to do unbreakable dashes and therefore won't be available. \*(C` and 39.\" \*(C' expand to `' in nroff, nothing in troff, for use with C<> 40.tr \(*W-|\(bv\*(Tr 41.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' 42.ie n \{\ 43. ds -- \(*W- 44. ds PI pi 45. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch 46. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch 47. ds L" "" 48. ds R" "" 49. ds C` "" 50. ds C' "" 51'br\} 52.el\{\ 53. ds -- \|\(em\| 54. ds PI \(*p 55. ds L" `` 56. ds R" '' 57'br\} 58.\" 59.\" If the F register is turned on, we'll generate index entries on stderr 60.\" for titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and 61.\" index entries marked with X<> in POD. Of course, you'll have to process 62.\" the output yourself in some meaningful fashion. 63.if \nF \{\ 64. de IX 65. tm Index:\\$1\t\\n%\t"\\$2" 66.. 67. nr % 0 68. rr F 69.\} 70.\" 71.\" For nroff, turn off justification. Always turn off hyphenation; it 72.\" makes way too many mistakes in technical documents. 73.hy 0 74.if n .na 75.\" 76.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). 77.\" Fear. Run. Save yourself. No user-serviceable parts. 78.bd B 3 79. \" fudge factors for nroff and troff 80.if n \{\ 81. ds #H 0 82. ds #V .8m 83. ds #F .3m 84. ds #[ \f1 85. ds #] \fP 86.\} 87.if t \{\ 88. ds #H ((1u-(\\\\n(.fu%2u))*.13m) 89. ds #V .6m 90. ds #F 0 91. ds #[ \& 92. ds #] \& 93.\} 94. \" simple accents for nroff and troff 95.if n \{\ 96. ds ' \& 97. ds ` \& 98. ds ^ \& 99. ds , \& 100. ds ~ ~ 101. ds / 102.\} 103.if t \{\ 104. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" 105. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' 106. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' 107. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' 108. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' 109. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' 110.\} 111. \" troff and (daisy-wheel) nroff accents 112.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' 113.ds 8 \h'\*(#H'\(*b\h'-\*(#H' 114.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] 115.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' 116.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' 117.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] 118.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] 119.ds ae a\h'-(\w'a'u*4/10)'e 120.ds Ae A\h'-(\w'A'u*4/10)'E 121. \" corrections for vroff 122.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' 123.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' 124. \" for low resolution devices (crt and lpr) 125.if \n(.H>23 .if \n(.V>19 \ 126\{\ 127. ds : e 128. ds 8 ss 129. ds o a 130. ds d- d\h'-1'\(ga 131. ds D- D\h'-1'\(hy 132. ds th \o'bp' 133. ds Th \o'LP' 134. ds ae ae 135. ds Ae AE 136.\} 137.rm #[ #] #H #V #F C 138.\" ====================================================================== 139.\" 140.IX Title "ERR_error_string 3"
|
142.UC 143.SH "NAME" 144ERR_error_string, ERR_error_string_n, ERR_lib_error_string, 145ERR_func_error_string, ERR_reason_error_string \- obtain human-readable 146error message 147.SH "SYNOPSIS" 148.IX Header "SYNOPSIS" 149.Vb 1 150\& #include <openssl/err.h> 151.Ve 152.Vb 2 153\& char *ERR_error_string(unsigned long e, char *buf); 154\& char *ERR_error_string_n(unsigned long e, char *buf, size_t len); 155.Ve 156.Vb 3 157\& const char *ERR_lib_error_string(unsigned long e); 158\& const char *ERR_func_error_string(unsigned long e); 159\& const char *ERR_reason_error_string(unsigned long e); 160.Ve 161.SH "DESCRIPTION" 162.IX Header "DESCRIPTION" 163\&\fIERR_error_string()\fR generates a human-readable string representing the 164error code \fIe\fR, and places it at \fIbuf\fR. \fIbuf\fR must be at least 120 165bytes long. If \fIbuf\fR is \fB\s-1NULL\s0\fR, the error string is placed in a 166static buffer. 167\&\fIERR_error_string_n()\fR is a variant of \fIERR_error_string()\fR that writes 168at most \fIlen\fR characters (including the terminating 0) 169and truncates the string if necessary. 170For \fIERR_error_string_n()\fR, \fIbuf\fR may not be \fB\s-1NULL\s0\fR. 171.PP 172The string will have the following format: 173.PP 174.Vb 1 175\& error:[error code]:[library name]:[function name]:[reason string] 176.Ve 177\&\fIerror code\fR is an 8 digit hexadecimal number, \fIlibrary name\fR, 178\&\fIfunction name\fR and \fIreason string\fR are \s-1ASCII\s0 text. 179.PP 180\&\fIERR_lib_error_string()\fR, \fIERR_func_error_string()\fR and 181\&\fIERR_reason_error_string()\fR return the library name, function 182name and reason string respectively. 183.PP 184The OpenSSL error strings should be loaded by calling 185ERR_load_crypto_strings(3) or, for \s-1SSL\s0 186applications, SSL_load_error_strings(3) 187first. 188If there is no text string registered for the given error code, 189the error string will contain the numeric code. 190.PP 191ERR_print_errors(3) can be used to print 192all error codes currently in the queue. 193.SH "RETURN VALUES" 194.IX Header "RETURN VALUES" 195\&\fIERR_error_string()\fR returns a pointer to a static buffer containing the 196string if \fIbuf\fR \fB== \s-1NULL\s0\fR, \fIbuf\fR otherwise. 197.PP 198\&\fIERR_lib_error_string()\fR, \fIERR_func_error_string()\fR and 199\&\fIERR_reason_error_string()\fR return the strings, and \fB\s-1NULL\s0\fR if 200none is registered for the error code. 201.SH "SEE ALSO" 202.IX Header "SEE ALSO" 203err(3), ERR_get_error(3), 204ERR_load_crypto_strings(3), 205SSL_load_error_strings(3) 206ERR_print_errors(3) 207.SH "HISTORY" 208.IX Header "HISTORY" 209\&\fIERR_error_string()\fR is available in all versions of SSLeay and OpenSSL. 210\&\fIERR_error_string_n()\fR was added in OpenSSL 0.9.6.
| 142.UC 143.SH "NAME" 144ERR_error_string, ERR_error_string_n, ERR_lib_error_string, 145ERR_func_error_string, ERR_reason_error_string \- obtain human-readable 146error message 147.SH "SYNOPSIS" 148.IX Header "SYNOPSIS" 149.Vb 1 150\& #include <openssl/err.h> 151.Ve 152.Vb 2 153\& char *ERR_error_string(unsigned long e, char *buf); 154\& char *ERR_error_string_n(unsigned long e, char *buf, size_t len); 155.Ve 156.Vb 3 157\& const char *ERR_lib_error_string(unsigned long e); 158\& const char *ERR_func_error_string(unsigned long e); 159\& const char *ERR_reason_error_string(unsigned long e); 160.Ve 161.SH "DESCRIPTION" 162.IX Header "DESCRIPTION" 163\&\fIERR_error_string()\fR generates a human-readable string representing the 164error code \fIe\fR, and places it at \fIbuf\fR. \fIbuf\fR must be at least 120 165bytes long. If \fIbuf\fR is \fB\s-1NULL\s0\fR, the error string is placed in a 166static buffer. 167\&\fIERR_error_string_n()\fR is a variant of \fIERR_error_string()\fR that writes 168at most \fIlen\fR characters (including the terminating 0) 169and truncates the string if necessary. 170For \fIERR_error_string_n()\fR, \fIbuf\fR may not be \fB\s-1NULL\s0\fR. 171.PP 172The string will have the following format: 173.PP 174.Vb 1 175\& error:[error code]:[library name]:[function name]:[reason string] 176.Ve 177\&\fIerror code\fR is an 8 digit hexadecimal number, \fIlibrary name\fR, 178\&\fIfunction name\fR and \fIreason string\fR are \s-1ASCII\s0 text. 179.PP 180\&\fIERR_lib_error_string()\fR, \fIERR_func_error_string()\fR and 181\&\fIERR_reason_error_string()\fR return the library name, function 182name and reason string respectively. 183.PP 184The OpenSSL error strings should be loaded by calling 185ERR_load_crypto_strings(3) or, for \s-1SSL\s0 186applications, SSL_load_error_strings(3) 187first. 188If there is no text string registered for the given error code, 189the error string will contain the numeric code. 190.PP 191ERR_print_errors(3) can be used to print 192all error codes currently in the queue. 193.SH "RETURN VALUES" 194.IX Header "RETURN VALUES" 195\&\fIERR_error_string()\fR returns a pointer to a static buffer containing the 196string if \fIbuf\fR \fB== \s-1NULL\s0\fR, \fIbuf\fR otherwise. 197.PP 198\&\fIERR_lib_error_string()\fR, \fIERR_func_error_string()\fR and 199\&\fIERR_reason_error_string()\fR return the strings, and \fB\s-1NULL\s0\fR if 200none is registered for the error code. 201.SH "SEE ALSO" 202.IX Header "SEE ALSO" 203err(3), ERR_get_error(3), 204ERR_load_crypto_strings(3), 205SSL_load_error_strings(3) 206ERR_print_errors(3) 207.SH "HISTORY" 208.IX Header "HISTORY" 209\&\fIERR_error_string()\fR is available in all versions of SSLeay and OpenSSL. 210\&\fIERR_error_string_n()\fR was added in OpenSSL 0.9.6.
|