cfbae19e62d59d025beca145e1962456bfdf05c5
[platform/upstream/krb5.git] / doc / html / _sources / appdev / refs / api / krb5_kt_get_entry.txt
1 krb5_kt_get_entry -  Get an entry from a key table. 
2 ====================================================
3
4 ..
5
6 .. c:function:: krb5_error_code krb5_kt_get_entry(krb5_context context, krb5_keytab keytab, krb5_const_principal principal, krb5_kvno vno, krb5_enctype enctype, krb5_keytab_entry * entry)
7
8 ..
9
10
11 :param:
12
13                   **[in]** **context** - Library context
14
15                   **[in]** **keytab** - Key table handle
16
17                   **[in]** **principal** - Principal name
18
19                   **[in]** **vno** - Key version number (0 for highest available)
20
21                   **[in]** **enctype** - Encryption type (0 zero for any enctype)
22
23                   **[out]** **entry** - Returned entry from key table
24
25
26 ..
27
28
29 :retval:
30          -   0   Success
31          -   Kerberos   error codes on failure
32
33
34 ..
35
36
37
38
39
40
41
42 Retrieve an entry from a key table which matches the *keytab* , *principal* , *vno* , and *enctype* . If *vno* is zero, retrieve the highest-numbered kvno matching the other fields. If *enctype* is 0, match any enctype.
43
44
45
46 Use :c:func:`krb5_free_keytab_entry_contents()` to free *entry* when it is no longer needed.
47
48
49
50
51
52
53
54
55
56
57 ..
58
59
60
61
62
63
64 .. note::
65
66          If *vno* is zero, the function retrieves the highest-numbered-kvno entry that matches the specified principal.
67  
68
69
70