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

153 releases since Mac OS X 10.0; the text changed 2 times.

  1. 10.0–10.1.5
  2. 10.3–10.6.8
  3. 10.7–26.5

Standards

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

From Libc 1752.120.2 in macOS 26.5. Parsed by carta from the page's mdoc source.