oracular (3) shisa_enumerate_principals.3.gz

Provided by: libshisa-dev_1.0.3-5_amd64 bug

NAME
       shisa_enumerate_principals - API function


SYNOPSIS
       #include <shisa.h>

       int  shisa_enumerate_principals(Shisa  *  dbh,  const  char  *  realm,  char  ***  principals,  size_t  *
       nprincipals);


ARGUMENTS
       Shisa * dbh Shisa library handle created by shisa().

       const char * realm
                   Name of realm, as null-terminated UTF-8 string.

       char *** principals
                   Returned pointer to newly allocated array of just  allocated  null-terminated  UTF-8  strings
                   with principal names.

       size_t * nprincipals
                   Pointer to an integer updated with the number of just allocated and returned principal names.


DESCRIPTION
       Extracts  a list of all principal names in backend belonging to the realm realm, as null-terminated UTF-8
       strings.  The caller is responsible for deallocating all strings and the array *principals.


RETURN VALUE
       Returns SHISA_OK on success, SHISA_NO_REALM if the specified realm does  not  exist,  or  an  error  code
       otherwise.


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/


       Copyright © 2002-2022 Simon Josefsson.
       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.


SEE ALSO
       The full documentation for shishi is maintained as a Texinfo manual.  If the info and shishi programs are
       properly installed at your site, the command

              info shishi

       should give you access to the complete manual.