File: shishi_prompt_password_callback_set.3

package info (click to toggle)
shishi 1.0.0-1
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 22,144 kB
  • ctags: 7,865
  • sloc: ansic: 61,153; sh: 12,212; yacc: 1,219; makefile: 1,164; perl: 624; sed: 16
file content (47 lines) | stat: -rw-r--r-- 1,629 bytes parent folder | download
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
35
36
37
38
39
40
41
42
43
44
45
46
47
.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
.TH "shishi_prompt_password_callback_set" 3 "1.0.0" "shishi" "shishi"
.SH NAME
shishi_prompt_password_callback_set \- API function
.SH SYNOPSIS
.B #include <shishi.h>
.sp
.BI "void shishi_prompt_password_callback_set(Shishi * " handle ", shishi_prompt_password_func " cb ");"
.SH ARGUMENTS
.IP "Shishi * handle" 12
shishi handle as allocated by \fBshishi_init()\fP.
.IP "shishi_prompt_password_func cb" 12
function pointer to application password callback, a
\fBshishi_prompt_password_func\fP type.
.SH "DESCRIPTION"
Set a callback function that will be used by
\fBshishi_prompt_password()\fP to query the user for a password.  The
function pointer can be retrieved using
\fBshishi_prompt_password_callback_get()\fP.

The \fIcb\fP function should follow the \fBshishi_prompt_password_func\fP prototype:

int prompt_password (Shishi * \fIhandle\fP, char **\fIs\fP,
const char *\fIformat\fP, va_list \fIap\fP);

If the function returns 0, the \fIs\fP variable should contain a newly
allocated string with the password read from the user.
.SH "REPORTING BUGS"
Report bugs to <bug-shishi@gnu.org>.
.SH COPYRIGHT
Copyright \(co 2002-2010 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.
.SH "SEE ALSO"
The full documentation for
.B shishi
is maintained as a Texinfo manual.  If the
.B info
and
.B shishi
programs are properly installed at your site, the command
.IP
.B info shishi
.PP
should give you access to the complete manual.