draft/man3/catgets.3

   1 .\" Copyright 1993 Mitchum DSouza <m.dsouza@mrc-applied-psychology.cambridge.ac.uk>
   2 .\"
   3 .\" Permission is granted to make and distribute verbatim copies of this
   4 .\" manual provided the copyright notice and this permission notice are
   5 .\" preserved on all copies.
   6 .\"
   7 .\" Permission is granted to copy and distribute modified versions of this
   8 .\" manual under the conditions for verbatim copying, provided that the
   9 .\" entire resulting derived work is distributed under the terms of a
  10 .\" permission notice identical to this one.
  11 .\"
  12 .\" Since the Linux kernel and libraries are constantly changing, this
  13 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  14 .\" responsibility for errors or omissions, or for damages resulting from
  15 .\" the use of the information contained herein.  The author(s) may not
  16 .\" have taken the same level of care in the production of this manual,
  17 .\" which is licensed free of charge, as they might when working
  18 .\" professionally.
  19 .\"
  20 .\" Formatted or processed versions of this manual, if unaccompanied by
  21 .\" the source, must acknowledge the copyright and authors of this work.
  22 .\"
  23 .\" Updated, aeb, 980809
  24 .\"
  25 .\" Japanese Version Copyright (c) 1997 HIROFUMI Nishizuka
  26 .\"     all rights reserved.
  27 .\" Translated Tue Dec 16 19:43:01 JST 1997
  28 .\"     by HIROFUMI Nishizuka <nishi@rpts.cl.nec.co.jp>
  29 .\" Updated & Modified Mon Mar 1 1999
  30 .\"       by NAKANO Takeo <nakano@apm.seikei.ac.jp>
  31 .\"
  32 .TH CATGETS 3 1998-08-09 "" "Linux Programmer's Manual"
  33 .\"O .SH NAME
  34 .\"O catgets \- get message from a message catalog
  35 .SH Ì¾Á°
  36 catgets \- ¥á¥Ã¥»¡¼¥¸¥«¥¿¥í¥°¤«¤é¥á¥Ã¥»¡¼¥¸¤ò¼è¤ê½Ð¤¹
  37 .\"O .SH SYNOPSIS
  38 .SH ½ñ¼°
  39 .nf
  40 .B #include <nl_types.h>
  41
  42 .BI "char *catgets(nl_catd " catalog ", int " set_number \
  43 ", int " message_number ,
  44 .BI "              const char *" message );
  45 .fi
  46 .\"O .SH DESCRIPTION
  47 .SH ÀâÌÀ
  48 .\"O .BR catgets ()
  49 .\"O reads the message
  50 .\"O .IR message_number ,
  51 .\"O in set
  52 .\"O .IR set_number ,
  53 .\"O from the message catalog identified by
  54 .\"O .IR catalog ,
  55 .\"O where
  56 .\"O .I catalog
  57 .\"O is a catalog descriptor returned from an earlier call to
  58 .\"O .BR catopen (3).
  59 .BR catgets ()
  60 ¤Ï catalog ¤Ç»ØÄê¤µ¤ì¤¿¥á¥Ã¥»¡¼¥¸¥«¥¿¥í¥°¤«¤é¡¢
  61 ¥»¥Ã¥È
  62 .I set_number
  63 ¤Î¥á¥Ã¥»¡¼¥¸
  64 .I message_number
  65 ¤òÆÉ¤ß¼è¤ë¡£
  66 .I catalog
  67 ¤Ï¡¢
  68 .BR catopen (3)
  69 ¤Î¸Æ¤Ó½Ð¤·¤Ë¤è¤Ã¤ÆÆÀ¤é¤ì¤¿¥«¥¿¥í¥°
  70 ¥Ç¥£¥¹¥¯¥ê¥×¥¿¤ò»ØÄê¤¹¤ë¡£
  71 .\"O The fourth argument
  72 .\"O .I message
  73 .\"O points to a default message string which will be returned by
  74 .\"O .BR catgets ()
  75 .\"O if the identified message catalog is not currently available.
  76 .\"O The
  77 .\"O message-text is contained in an internal buffer area and should be copied by
  78 .\"O the application if it is to be saved or modified.
  79 .\"O The return string is
  80 .\"O always terminated with a null byte.
  81 4ÈÖÌÜ¤Î°ú¿ô
  82 .I message
  83 ¤Ï¡¢»ØÄê¤Î¥á¥Ã¥»¡¼¥¸¥«¥¿¥í¥°¤¬¸½ºßÍøÍÑ¤Ç¤¤Ê¤¤
  84 ¾ì¹ç¤Ë
  85 .BR catgets ()
  86 ¤¬ÊÖ¤¹¥Ç¥Õ¥©¥ë¥È¤Î¥á¥Ã¥»¡¼¥¸¤ò»Ø¤¹¡£
  87 ¥á¥Ã¥»¡¼¥¸¥Æ¥¥¹¥È¤ÏÆâÉô¤Î¥Ð¥Ã¥Õ¥¡ÎÎ°è¤Ë³ÊÇ¼¤µ¤ì¤Æ¤ª¤ê¡¢
  88 ÊÝÂ¸¤äÊÑ¹¹¤ò¹Ô¤¦¾ì¹ç¤Ë¤Ï¥¢¥×¥ê¥±¡¼¥·¥ç¥óÂ¦¤Ç¥³¥Ô¡¼¤¹¤ëÉ¬Í×¤¬¤¢¤ë¡£
  89 ÊÖ¤µ¤ì¤ëÊ¸»úÎó¤Ï¾ï¤Ë¥Ì¥ëÊ¸»ú¤Ç½ªÃ¼¤µ¤ì¤ë¡£
  90 .\"O .SH "RETURN VALUE"
  91 .SH ÊÖ¤êÃÍ
  92 .LP
  93 .\"O On success,
  94 .\"O .BR catgets ()
  95 .\"O returns a pointer to an internal buffer area
  96 .\"O containing the null-terminated message string.
  97 À®¸ù¤·¤¿¾ì¹ç¡¢
  98 .BR catgets ()
  99 ¤ÏÆâÉô¤Î¥Ð¥Ã¥Õ¥¡ÎÎ°è¤Ø¤Î¥Ý¥¤¥ó¥¿¤òÊÖ¤¹¡£
 100 ¤³¤³¤Ë¤Ï¥Ì¥ëÊ¸»ú¤Ç½ªÃ¼¤µ¤ì¤¿¥á¥Ã¥»¡¼¥¸Ê¸»úÎó¤¬³ÊÇ¼¤µ¤ì¤Æ¤¤¤ë¡£
 101 .\"O On failure,
 102 .\"O .BR catgets ()
 103 .\"O returns the value
 104 .\"O .IR message .
 105 ¼ºÇÔ¤·¤¿¾ì¹ç¤Ï
 106 .I message
 107 ¤òÊÖ¤¹¡£
 108 .\"O .SH "CONFORMING TO"
 109 .SH ½àµò
 110 POSIX.1-2001.
 111 .\"O .SH NOTES
 112 .SH Ãí°Õ
 113 .\"O These functions are only available in libc.so.4.4.4c and above.
 114 .\"O The Jan 1987 X/Open Portability Guide specifies a more subtle
 115 .\"O error return:
 116 .\"O .I message
 117 .\"O is returned if the message catalog specified by
 118 .\"O .I catalog
 119 .\"O is not available, while an empty string is returned
 120 .\"O when the message catalog is available but does not contain
 121 .\"O the specified message.
 122 ¤³¤ì¤é¤Î´Ø¿ô¤Ï libc.so.4.4.4c °Ê¹ß¤Ç¤·¤«»È¤¨¤Ê¤¤¡£
 123 Jan 1987 X/Open Portability Guide ¤Ç¤Ï¡¢¥¨¥é¡¼¤Î»þ¤Ë
 124 ÊÖ¤µ¤ì¤ëÃÍ¤Ë¤è¤êÈùÌ¯¤Ê»ØÄê¤ò¤·¤Æ¤¤¤ë¡£
 125 .I catalog
 126 ¤Ç»ØÄê¤µ¤ì¤¿¥á¥Ã¥»¡¼¥¸¥«¥¿¥í¥°¤¬ÍøÍÑ¤Ç¤¤Ê¤¤¾ì¹ç¤Ï
 127 .I message
 128 ¤òÊÖ¤·¡¢°ìÊý¥á¥Ã¥»¡¼¥¸¥«¥¿¥í¥°¤Ï¤¢¤ë¤¬»ØÄê¤·¤¿¥á¥Ã¥»¡¼¥¸¤¬¤Ê¤¤¾ì¹ç¤Ï
 129 ¶õ¤ÎÊ¸»úÎó¤¬ÊÖ¤µ¤ì¤ë¡£
 130 .\"O These two possible error returns seem to be discarded in SUSv2
 131 .\"O in favor of always returning
 132 .\"O .IR message .
 133 SUSv2 ¤Ç¤Ï¤³¤ÎÆó¼ïÎà¤Î¥¨¥é¡¼¥ê¥¿¡¼¥ó¤ÏÇÑ»ß¤µ¤ì¡¢
 134 ¾ï¤Ë
 135 .I message
 136 ¤òÊÖ¤¹¤³¤È¤Ë¤·¤¿¤è¤¦¤Ç¤¢¤ë¡£
 137 .\"O .SH "SEE ALSO"
 138 .SH ´ØÏ¢¹àÌÜ
 139 .BR catopen (3),
 140 .BR setlocale (3)