shisa_enumerate_principals(3)

API function

Section 3 libshisa-dev bookworm source

Description

shisa_enumerate_principals

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

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.