xref: /freebsd/crypto/krb5/doc/html/_sources/appdev/refs/api/krb5_chpw_message.rst.txt (revision 7f2fe78b9dd5f51c821d771b63d2e096f6fd49e9)
1krb5_chpw_message -  Get a result message for changing or setting a password.
2==============================================================================
3
4..
5
6.. c:function:: krb5_error_code krb5_chpw_message(krb5_context context, const krb5_data * server_string, char ** message_out)
7
8..
9
10
11:param:
12
13	          **[in]** **context** - Library context
14
15	          **[in]** **server_string** - Data returned from the remote system
16
17	          **[out]** **message_out** - A message displayable to the user
18
19
20..
21
22
23:retval:
24         -   0   Success
25
26
27:return:
28         -  Kerberos error codes
29
30..
31
32
33
34
35
36
37
38This function processes the *server_string* returned in the *result_string* parameter of krb5_change_password(), krb5_set_password(), and related functions, and returns a displayable string. If *server_string* contains Active Directory structured policy information, it will be converted into human-readable text.
39
40
41
42Use krb5_free_string() to free *message_out* when it is no longer needed.
43
44
45
46
47
48
49
50
51
52
53..
54
55
56
57
58.. note::
59
60	 New in 1.11
61
62
63