ec50809c440bbd471acfa00c1fa4f89858139600
[platform/upstream/krb5.git] / doc / html / _sources / appdev / refs / api / krb5_init_context.txt
1 krb5_init_context -  Create a krb5 library context. 
2 ====================================================
3
4 ..
5
6 .. c:function:: krb5_error_code krb5_init_context(krb5_context * context)
7
8 ..
9
10
11 :param:
12
13                   **[out]** **context** - Library context
14
15
16 ..
17
18
19 :retval:
20          -   0   Success
21
22
23 :return:
24          -  Kerberos error codes 
25
26 ..
27
28
29
30
31
32
33
34 The *context* must be released by calling :c:func:`krb5_free_context()` when it is no longer needed.
35
36
37
38
39
40
41
42
43
44
45 ..
46
47
48
49
50
51 .. warning::
52
53          Any program or module that needs the Kerberos code to not trust the environment must use :c:func:`krb5_init_secure_context()` , or clean out the environment.
54  
55
56
57
58