Imported Upstream version 1.15.1
[platform/upstream/krb5.git] / doc / html / _sources / appdev / refs / api / krb5_get_error_message.txt
1 krb5_get_error_message -  Get the (possibly extended) error message for a code. 
2 ================================================================================
3
4 ..
5
6 .. c:function:: const char * krb5_get_error_message(krb5_context ctx, krb5_error_code code)
7
8 ..
9
10
11 :param:
12
13                   **[in]** **ctx** - Library context
14
15                   **[in]** **code** - Error code
16
17
18 ..
19
20
21
22 ..
23
24
25
26
27
28
29
30 The behavior of :c:func:`krb5_get_error_message()` is only defined the first time it is called after a failed call to a krb5 function using the same context, and only when the error code passed in is the same as that returned by the krb5 function.
31
32
33
34 This function never returns NULL, so its result may be used unconditionally as a C string.
35
36
37
38 The string returned by this function must be freed using :c:func:`krb5_free_error_message()` 
39
40
41
42
43
44
45
46
47
48
49 ..
50
51
52
53
54
55
56 .. note::
57
58          Future versions may return the same string for the second and following calls.
59  
60
61
62