.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
.TH "shisa_principal_remove" 3 "1.0.3" "shishi" "shishi"
.SH NAME
shisa_principal_remove \- API function
.SH SYNOPSIS
.B #include <shisa.h>
.sp
.BI "int shisa_principal_remove(Shisa * " dbh ", const char * " realm ", const char * " principal ");"
.SH ARGUMENTS
.IP "Shisa * dbh" 12
Shisa library handle created by \fBshisa()\fP.
.IP "const char * realm" 12
Name of the realm the principal belongs to.
.IP "const char * principal" 12
Name of the principal to remove.  Set to \fBNULL\fP,
only the realm \fIrealm\fP is removed.
.SH "DESCRIPTION"
Removes all information stored in the database for the given
principal PRINCIPAL@REALM.  When \fIprincipal\fP is \fBNULL\fP, then the
realm \fIrealm\fP is itself removed, but this can only succeed if
the realm is already empty of principals.
.SH "RETURN VALUE"
Returns \fBSHISA_OK\fP if successful, 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.