KRB5\_RD\_ERROR(3) Library Functions Manual KRB5\_RD\_ERROR(3)

# [NAME](#NAME)

`krb5_rd_error`, `krb5_free_error`, `krb5_free_error_contents`, `krb5_error_from_rd_error` — parse, free and read error from KRB-ERROR message

# [LIBRARY](#LIBRARY)

Kerberos 5 Library (libkrb5, -lkrb5)

# [SYNOPSIS](#SYNOPSIS)

`#include <krb5.h>`

`krb5_error_code`  
`krb5_rd_error`(`krb5_context context`, `const krb5_data *msg`, `KRB_ERROR *result`);

`void`  
`krb5_free_error`(`krb5_context context`, `krb5_error *error`);

`void`  
`krb5_free_error_contents`(`krb5_context context`, `krb5_error *error`);

`krb5_error_code`  
`krb5_error_from_rd_error`(`krb5_context context`, `const krb5_error *error`, `const krb5_creds *creds`);

# [DESCRIPTION](#DESCRIPTION)

Usually applications never needs to parse and understand Kerberos error messages since higher level functions will parse and push up the error in the krb5\_context. These functions are described for completeness.

[`krb5_rd_error`](#krb5_rd_error)() parses and returns the kerboeros error message, the structure should be freed with `krb5_free_error_contents`() when the caller is done with the structure.

[`krb5_free_error`](#krb5_free_error)() frees the content and the memory region holding the structure iself.

[`krb5_free_error_contents`](#krb5_free_error_contents)() free the content of the KRB-ERROR message.

[`krb5_error_from_rd_error`](#krb5_error_from_rd_error)() will parse the error message and set the error buffer in krb5\_context to the error string passed back or the matching error code in the KRB-ERROR message. Caller should pick up the message with [`krb5_get_error_string`](#krb5_get_error_string)(`3`) (don't forget to free the returned string with [`krb5_free_error_string`](#krb5_free_error_string)()).

# [SEE ALSO](#SEE_ALSO)

[krb5(3)](/man/os/heimdal/krb5.3), [krb5\_set\_error\_string(3)](/man/os/heimdal/krb5_set_error_string.3), [krb5\_get\_error\_string(3)](/man/os/heimdal/krb5_get_error_string.3), [krb5.conf(5)](/man/os/heimdal/krb5.conf.5)

July 26, 2004 HEIMDAL

---

Document: krb5_rd_error(3) from heimdal 7.8.0-r54 (Chainguard OS)
Source: https://github.com/heimdal/heimdal
