.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
.TH "shisa_key_remove" 3 "1.0.3" "shishi" "shishi"
.SH NAME
shisa_key_remove \- API function
.SH SYNOPSIS
.B #include <shisa.h>
.sp
.BI "int shisa_key_remove(Shisa * " dbh ", const char * " realm ", const char * " principal ", const Shisa_key * " key ");"
.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 whose key is to be removed.
.IP "const Shisa_key * key" 12
Pointer to a Shisa key structure with hints on matching
criteria for the key to select.
.SH "DESCRIPTION"
Removes from the Shisa database a key, matching the hints in \fIkey\fP,
for the user PRINCIPAL@REALM.  Not all elements of \fIkey\fP need to be
filled in, only those relevant to locate the key uniquely.

For example, if you want to remove the only key of etype 3,
i.e., DES\-CBC\-MD5, then set the field \fIkey\fP\->etype to 3, and
all other fields to zero.
.SH "RETURN VALUE"
Returns \fBSHISA_OK\fP on success, \fBSHISA_NO_KEY\fP if no key
could be located, \fBSHISA_MULTIPLE_KEY_MATCH\fP if more than one
key matched the given criteria, 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.