.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. .TH "shisa_principal_update" 3 "1.0.2" "shishi" "shishi" .SH NAME shisa_principal_update \- API function .SH SYNOPSIS .B #include .sp .BI "int shisa_principal_update(Shisa * " dbh ", const char * " realm ", const char * " principal ", const Shisa_principal * " ph ");" .SH ARGUMENTS .IP "Shisa * dbh" 12 Shisa library handle created by \fBshisa()\fP. .IP "const char * realm" 12 Name of realm the principal belongs in. .IP "const char * principal" 12 Name of principal to get information on. .IP "const Shisa_principal * ph" 12 Pointer to principal structure with information to store in database. .SH "DESCRIPTION" Modify information stored for given PRINCIPAL\fIREALM\fP. Note that it is usually a good idea to only set the fields in \fIph\fP that you actually want to update. Specifically, first calling \fBshisa_principal_find()\fP to get the current information, then modifying one field, and calling \fBshisa_principal_update()\fP is not recommended in general, as this will 1) overwrite any modifications made to other fields between the two calls (by other processes) and 2) will cause all values to be written again, which may generate more overhead. .SH "RETURN VALUE" Returns SHISA_OK if successful, \fBSHISA_NO_REALM\fP if the indicated realm does not exist, \fBSHISA_NO_PRINCIPAL\fP if the indicated principal does not exist, or an error code. .SH "REPORTING BUGS" Report bugs to . .SH COPYRIGHT Copyright \(co 2002-2010 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.