catgets(3)

catgets3

Retrieve string from message catalog

Usage

#include <nl_types.h>

char *

catgets(nl_catd catd, int set_id, int msg_id, const char *s);

Library

Standard C Library (libc, -lc)

Overview

The catgets() function attempts to retrieve message msg_id of set set_id from the message catalog referenced by the descriptor catd. The argument s points to a default message which is returned if the function is unable to retrieve the specified message.

Return values

If the specified message was retrieved successfully, catgets() returns a pointer to an internal buffer containing the message string; otherwise it returns s.

Errors

[EBADF]

The catd argument is not a valid message catalog descriptor.

[EBADMSG]

The message identified by set_id and msg_id is not in the message catalog.

Releases

87 releases since FreeBSD 2.0.5-RELEASE; the text changed 47 times.

  1. 2.0.5
  2. 2.1.5–2.1.7.1
  3. 2.2.2–2.2.6
  4. 2.2.7–2.2.8
  5. 2.2.9
  6. 3.0–3.2
  7. 3.3
  8. 3.4
  9. 3.5–3.5.1
  10. 4.0
  11. 4.1
  12. 4.1.1–4.3
  13. 4.4
  14. 4.5–4.11
  15. 5.0–5.5
  16. 6.0–6.3
  17. 6.4
  18. 7.0
  19. 7.1
  20. 7.2
  21. 7.3
  22. 7.4
  23. 8.0
  24. 8.1
  25. 8.2
  26. 8.3
  27. 8.4
  28. 9.0
  29. 9.1
  30. 9.2
  31. 9.3
  32. 10.0
  33. 10.1
  34. 10.2
  35. 10.3
  36. 10.4
  37. 11.0
  38. 11.1
  39. 11.2
  40. 11.3
  41. 11.4
  42. 12.0
  43. 12.1
  44. 12.2
  45. 12.3
  46. 12.4
  47. 13.0–13.2
  48. 13.3–16.0

Standards

The catgets() function conforms to IEEE Std 1003.1-2001 (“POSIX.1”).

From base 16.0-CURRENT-20261027-61c70dc16a79 in FreeBSD 16.0-CURRENT (2026-10-27). Parsed by carta from the page's mdoc source.