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
|
.\" DO NOT MODIFY THIS FILE! It was generated by gdoc.
.TH "shisa_enumerate_realms" 3 "1.0.3" "shishi" "shishi"
.SH NAME
shisa_enumerate_realms \- API function
.SH SYNOPSIS
.B #include <shisa.h>
.sp
.BI "int shisa_enumerate_realms(Shisa * " dbh ", char *** " realms ", size_t * " nrealms ");"
.SH ARGUMENTS
.IP "Shisa * dbh" 12
Shisa library handle created by \fBshisa()\fP.
.IP "char *** realms" 12
Returned pointer to a newly allocated array of also
allocated and null\-terminated UTF\-8 strings with realm names.
.IP "size_t * nrealms" 12
Pointer to a number which is updated with the number
of just allocated and returned realm strings.
.SH "DESCRIPTION"
Extracts a list of all realm names in backend, as null\-terminated
UTF\-8 strings. The caller is responsible for deallocating all
strings as well as the array *\fIrealms\fP.
.SH "RETURN VALUE"
Returns \fBSHISA_OK\fP on success, or an error code.
.SH "REPORTING BUGS"
Report bugs to <bug-shishi@gnu.org>.
GNU Shishi home page: http://www.gnu.org/software/shishi/
General help using GNU software: http://www.gnu.org/gethelp/
.SH COPYRIGHT
Copyright \(co 2002-2022 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.
|
