Imported Upstream version 1.15.1
[platform/upstream/krb5.git] / doc / html / _sources / appdev / refs / api / krb5_unparse_name_flags.txt
1 krb5_unparse_name_flags -  Convert krb5_principal structure to a string with flags. 
2 ====================================================================================
3
4 ..
5
6 .. c:function:: krb5_error_code krb5_unparse_name_flags(krb5_context context, krb5_const_principal principal, int flags, char ** name)
7
8 ..
9
10
11 :param:
12
13                   **[in]** **context** - Library context
14
15                   **[in]** **principal** - Principal
16
17                   **[in]** **flags** - Flags
18
19                   **[out]** **name** - String representation of principal name
20
21
22 ..
23
24
25 :retval:
26          -   0   Success
27
28
29 :return:
30          -  Kerberos error codes. On failure name is set to NULL 
31
32 ..
33
34
35
36
37
38
39
40 Similar to :c:func:`krb5_unparse_name()` , this function converts a krb5_principal structure to a string representation.
41
42
43
44 The following flags are valid: 
45  
46          - :data:`KRB5_PRINCIPAL_UNPARSE_SHORT` - omit realm if it is the local realm
47  
48  
49          - :data:`KRB5_PRINCIPAL_UNPARSE_NO_REALM` - omit realm
50  
51  
52          - :data:`KRB5_PRINCIPAL_UNPARSE_DISPLAY` - do not quote special characters
53  
54  Use :c:func:`krb5_free_unparsed_name()` to free *name* when it is no longer needed.
55
56
57
58
59
60
61
62
63
64
65 ..
66
67
68
69
70