1. 1
2. 2
3. 3
4. 4
5. 5
6. 6
7. 7
8. 8
9. 9
10. 10
11. 11
12. 12
13. 13
14. 14
15. 15
16. 16
17. 17
18. 18
19. 19
20. 20
21. 21
22. 22
23. 23
24. 24
25. 25
26. 26
27. 27
28. 28
29. 29
30. 30
31. 31
32. 32
33. 33
34. 34
35. 35
36. 36
37. 37
38. 38
39. 39
40. 40
41. 41
42. 42
43. 43
44. 44
45. 45
46. 46
47. 47
48. 48
49. 49
50. 50
51. 51
52. 52

.\" Copyright 2025 Shota FUJI
.\"
.\" Licensed under the Zero-Clause BSD License or the Apache License, Version 2.0, at your option.
.\" You may not use, copy, modify, or distribute this file except according to those terms. You can
.\" find a copy of the Zero-Clause BSD License at LICENSES/0BSD.txt, and a copy of the Apache License,
.\" Version 2.0 at LICENSES/Apache-2.0.txt. You may also obtain a copy of the Zero-Clause BSD License
.\" at <https://opensource.org/license/0bsd> and a copy of the Apache License, Version 2.0 at
.\" <https://www.apache.org/licenses/LICENSE-2.0>
.\"
.\" SPDX-License-Identifier: 0BSD OR Apache-2.0
.TH sood_get_result_string 3


.SH NAME
sood_get_result_string \- Get a textual representation of code returned by libsood functions


.SH SYNOPSIS
.nf
.B #include <sood.h>

\fBconst char* sood_get_result_string(sood_result \fIresult\fB);
.fi


.SH DESCRIPTION
Get a human\-readable textual representation of result code in C\-string
(NUL\-terminated string) form.


.SH RETURN VALUE
Pointer for the text, terminated by NUL character.


.SH EXAMPLES
.nf
#include <sood.h>

sood_result result;
result = sood_parse(&msg, bytes_ptr, bytes_len);
printf("%s\\n", sood_get_result_string(result));

printf("%s\\n", SOOD_OK); /* "OK" */
printf("%s\\n", SOOD_ERR_PARSE_EMPTY_KEY); /* "ERR_PARSE_EMPTY_KEY" */
.fi

.SH SEE ALSO

.BR sood (3),
.BR sood_discovery_response_parse (3),
.BR sood_parse (3),
.BR sood_message_iter_next (3)