~ubuntu-branches/ubuntu/natty/shishi/natty

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
.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
.TH "shisa_enumerate_principals" 3 "0.0.36" "shishi" "shishi"
.SH NAME
shisa_enumerate_principals \- API function
.SH SYNOPSIS
.B #include <shisa.h>
.sp
.BI "int shisa_enumerate_principals(Shisa * " dbh ", const char * " realm ", char *** " principals ", size_t * " nprincipals ");"
.SH ARGUMENTS
.IP "Shisa * dbh" 12
Shisa library handle created by \fBshisa()\fP.
.IP "const char * realm" 12
Name of realm, as zero-terminated UTF-8 string.
.IP "char *** principals" 12
.IP "size_t * nprincipals" 12
Pointer to number indicating number of allocated
realm strings.
.SH "DESCRIPTION"
Extract a list of all principal names in realm in backend, as
zero\-terminated UTF\-8 strings.  The caller must deallocate the
strings.
.SH "RETURN VALUE"
Returns SHISA_OK on success, SHISA_NO_REALM if the
specified realm does not exist, or error code.
.SH "REPORTING BUGS"
Report bugs to <bug-shishi@josefsson.org>.
.SH COPYRIGHT
Copyright \(co 2002-2008 Simon Josefsson.
.br
Permission is granted to make and distribute verbatim copies of this
manual provided the copyright notice and this permission notice are
preserved on all copies.
.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.