Initial import from FreeBSD RELENG_4:
[games.git] / crypto / heimdal / lib / krb5 / krb5_unparse_name.3
1 .\" Copyright (c) 1997 Kungliga Tekniska Högskolan
2 .\" $Id: krb5_unparse_name.3,v 1.6 2002/09/02 12:42:00 joda Exp $
3 .Dd August 8, 1997
4 .Dt KRB5_UNPARSE_NAME 3
5 .Os HEIMDAL
6 .Sh NAME
7 .Nm krb5_unparse_name
8 .\" .Nm krb5_unparse_name_ext
9 .Nd principal to string conversion
10 .Sh LIBRARY
11 Kerberos 5 Library (libkrb5, -lkrb5)
12 .Sh SYNOPSIS
13 .Fd #include <krb5.h>
14 .Ft krb5_error_code
15 .Fn krb5_unparse_name "krb5_context context" "krb5_principal principal" "char **name"
16 .\" .Ft krb5_error_code
17 .\" .Fn krb5_unparse_name_ext "krb5_context context" "krb5_const_principal principal" "char **name" "size_t *size"
18 .Sh DESCRIPTION
19 This function takes a
20 .Fa principal ,
21 and will convert in to a printable representation with the same syntax
22 as described in
23 .Xr krb5_parse_name 3 .
24 .Fa *name
25 will point to allocated data and should be freed by the caller.
26 .Sh SEE ALSO
27 .Xr krb5_425_conv_principal 3 ,
28 .Xr krb5_build_principal 3 ,
29 .Xr krb5_free_principal 3 ,
30 .Xr krb5_parse_name 3 ,
31 .Xr krb5_sname_to_principal 3