File: pskc_strerror_name.3

package info (click to toggle)
oath-toolkit 2.6.1-1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 20,824 kB
  • ctags: 9,237
  • sloc: ansic: 54,713; sh: 13,738; yacc: 1,254; xml: 756; makefile: 353
file content (34 lines) | stat: -rw-r--r-- 1,259 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
.TH "pskc_strerror_name" 3 "2.6.1" "libpskc" "libpskc"
.SH NAME
pskc_strerror_name \- API function
.SH SYNOPSIS
.B #include <pskc.h>
.sp
.BI "const char * pskc_strerror_name(int " err ");"
.SH ARGUMENTS
.IP "int err" 12
error code, a \fBpskc_rc\fP value.
.SH "DESCRIPTION"
Convert return code to human readable string representing the error
code symbol itself.  For example, pskc_strerror_name(\fBPSKC_OK\fP)
returns the string "PSKC_OK".

This string can be used to output a diagnostic message to the user.

This function is one of few in the library that can be used without
a successful call to \fBpskc_init()\fP.
.SH "RETURN VALUE"
Returns a pointer to a statically allocated string
containing a string version of the error code \fIerr\fP, or NULL if
the error code is not known.
.SH "REPORTING BUGS"
Report bugs to <oath-toolkit-help@nongnu.org>.
libpskc home page: http://www.gnu.org/software/libpskc/
General help using GNU software: http://www.gnu.org/gethelp/
.SH COPYRIGHT
Copyright \(co 2012-2015 Simon Josefsson.
.br
Copying and distribution of this file, with or without modification,
are permitted in any medium without royalty provided the copyright
notice and this notice are preserved.