.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
.TH "shishi_parse_name" 3 "1.0.3" "shishi" "shishi"
.SH NAME
shishi_parse_name \- API function
.SH SYNOPSIS
.B #include <shishi.h>
.sp
.BI "int shishi_parse_name(Shishi * " handle ", const char * " name ", char ** " principal ", char ** " realm ");"
.SH ARGUMENTS
.IP "Shishi * handle" 12
Shishi library handle created by \fBshishi_init()\fP.
.IP "const char * name" 12
input principal name string, e.g. imap/mail.gnu.org\\fIGNU\fP.ORG.
.IP "char ** principal" 12
newly allocated output string with principal name.
.IP "char ** realm" 12
newly allocated output string with realm name.
.SH "DESCRIPTION"
Split principal name (e.g., "simon\\fIJOSEFSSON\fP.ORG") into two
newly allocated strings, the \fIprincipal\fP ("simon"), and the \fIrealm\fP
("JOSEFSSON.ORG").  If there is no realm part in \fIname\fP, \fIrealm\fP is set
to NULL.
.SH "RETURN VALUE"
Returns SHISHI_INVALID_PRINCIPAL_NAME if \fIname\fP is NULL
or ends with the escape character "\", and SHISHI_OK if
successful.
.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.