.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
.TH "shisa_enumerate_principals" 3 "1.0.3" "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 null\-terminated UTF\-8 string.
.IP "char *** principals" 12
Returned pointer to newly allocated array of just
allocated null\-terminated UTF\-8 strings with principal names.
.IP "size_t * nprincipals" 12
Pointer to an integer updated with the number of just
allocated and returned principal names.
.SH "DESCRIPTION"
Extracts a list of all principal names in backend belonging to
the realm \fIrealm\fP, as null\-terminated UTF\-8 strings.  The caller
is responsible for deallocating all strings and the array
*\fIprincipals\fP.
.SH "RETURN VALUE"
Returns \fBSHISA_OK\fP on success, \fBSHISA_NO_REALM\fP if the
specified realm does not exist, or an error code otherwise.
.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.