xref: /freebsd/crypto/krb5/doc/html/_sources/appdev/refs/api/krb5_cccol_cursor_new.rst.txt (revision 7f2fe78b9dd5f51c821d771b63d2e096f6fd49e9)
1krb5_cccol_cursor_new -  Prepare to iterate over the collection of known credential caches.
2============================================================================================
3
4..
5
6.. c:function:: krb5_error_code krb5_cccol_cursor_new(krb5_context context, krb5_cccol_cursor * cursor)
7
8..
9
10
11:param:
12
13	          **[in]** **context** - Library context
14
15	          **[out]** **cursor** - Cursor
16
17
18..
19
20
21:retval:
22         -   0   Success; otherwise - Kerberos error codes
23
24
25..
26
27
28
29
30
31
32
33Get a new cache iteration *cursor* that will iterate over all known credential caches independent of type.
34
35
36
37Use krb5_cccol_cursor_free() to release *cursor* when it is no longer needed.
38
39
40
41
42
43
44
45
46
47
48..
49
50.. seealso::
51         krb5_cccol_cursor_next()
52
53
54
55
56
57