xref: /freebsd/crypto/krb5/doc/html/_sources/appdev/refs/api/krb5_cc_start_seq_get.rst.txt (revision 7f2fe78b9dd5f51c821d771b63d2e096f6fd49e9)
1krb5_cc_start_seq_get -  Prepare to sequentially read every credential in a credential cache.
2==============================================================================================
3
4..
5
6.. c:function:: krb5_error_code krb5_cc_start_seq_get(krb5_context context, krb5_ccache cache, krb5_cc_cursor * cursor)
7
8..
9
10
11:param:
12
13	          **[in]** **context** - Library context
14
15	          **[in]** **cache** - Credential cache handle
16
17	          **[out]** **cursor** - Cursor
18
19
20..
21
22
23:retval:
24         -   0   Success; otherwise - Kerberos error codes
25
26
27..
28
29
30
31
32
33
34
35krb5_cc_end_seq_get() must be called to complete the retrieve operation.
36
37
38
39
40
41
42
43
44
45
46..
47
48
49
50
51
52
53.. note::
54
55	 If the cache represented by *cache* is modified between the time of the call to this function and the time of the final krb5_cc_end_seq_get(), these changes may not be reflected in the results of krb5_cc_next_cred() calls.
56
57
58
59
60