(split) Import translated manuals from JM CVS Repository.

[linuxjm/LDP_man-pages.git] / obsolete / man3 / snprintf.3

.\" Hey Emacs! This file is -*- nroff -*- source.
.\" (c) 1995 by Jim Van Zandt <jrv@vanzandt.mv.com>
.\"
.\" Permission is granted to make and distribute verbatim copies of this
.\" manual provided the copyright notice and this permission notice are
.\" preserved on all copies.
.\"
.\" Permission is granted to copy and distribute modified versions of this
.\" manual under the conditions for verbatim copying, provided that the
.\" entire resulting derived work is distributed under the terms of a
.\" permission notice identical to this one.
.\" 
.\" Since the Linux kernel and libraries are constantly changing, this
.\" manual page may be incorrect or out-of-date.  The author(s) assume no
.\" responsibility for errors or omissions, or for damages resulting from
.\" the use of the information contained herein.  The author(s) may not
.\" have taken the same level of care in the production of this manual,
.\" which is licensed free of charge, as they might when working
.\" professionally.
.\" 
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.\" 
.\" Added _GNU_SOURCE, aeb, Sat Jul  5 23:10:04 MET 1997
.\"
.\" Japanese Version Copyright (c) 1998 Akihiro Motoki all rights reserved.
.\" Translated Mon May 25 1998 by Akihiro Motoki <motoki@hal.t.u-tokyo.ac.jp>
.\" Modified Thu Nov 11 1999 by Akihiro Motoki <motoki@ptl.abk.nec.co.jp>
.\"
.TH SNPRINTF 3  "16 September 1995" "GNU" "Linux Programmer's Manual"
.\"O .SH NAME
.\"O .snprintf, vsnprintf \- formatted output conversion
.SH ̾Á°
snprintf, vsnprintf \- »ØÄꤷ¤¿½ñ¼°¤Ç½ÐÎϤò¹Ô¤¦
.\"O .SH SYNOPSIS
.SH ½ñ¼°
.B #define _GNU_SOURCE
.br
.B #include <stdio.h>
.sp
.BI "int snprintf ( char *" str ", size_t " n ", "
.br
.BI "                         const char *" format ", ... );"
.sp
.B #include <stdarg.h>
.sp
.BI "int vsnprintf ( char *" str ", size_t " n ", "
.br
.BI "                         const char *" format ", va_list " ap " );"
.\"O .SH DESCRIPTION
.\"O \fBsnprintf\fP writes output to the string \fIstr\fP, under control of
.\"O the \fIformat\fP string that specifies how subsequent arguments are
.\"O converted for output.  It is similar to \fBsprintf\fP(3), except that
.\"O \fIn\fP specifies the maximum number of characters to produce.  The
.\"O trailing null character is counted towards this limit, so you should
.\"O allocate at least \fIn\fP characters for the string \fIstr\fP.
.SH ÀâÌÀ
\fBsnprintf\fP ´Ø¿ô¤Ï¡¢\fIformat\fP ¤Ç»ØÄꤵ¤ì¤¿½ñ¼°¤Ë½¾¤¤¡¢¤½¤ì°Ê¹ß¤Ë
Í¿¤¨¤é¤ì¤¿°ú¿ô¤òÀ°·Á¤·¤Æ½ÐÎϤ·¡¢½ÐÎϤÏʸ»úÎó \fIstr\fP ¤Ë½ñ¤­¹þ¤Þ¤ì¤ë¡£
¤³¤Î´Ø¿ô¤Ï \fBsprintf\fP(3) ¤Ë»÷¤Æ¤¤¤ë¤¬¡¢ ½ÐÎϤµ¤ì¤ë
ºÇÂçʸ»ú¿ô \fIn\fP ¤ò»ØÄê¤Ç¤­¤ëÅÀ¤¬°Û¤Ê¤ë¡£
ʸ»úÎó¤Î½ªÃ¼¤ò¼¨¤¹¥Ì¥ëʸ»ú¤âºÇÂçʸ»ú¿ô¤Ë´Þ¤Þ¤ì¤ë¤¿¤á¡¢
½ÐÎÏʸ»úÎó \fIstr\fP ¤Ë¤Ï¾¯¤Ê¤¯¤È¤â \fIn\fP ʸ»ú³ä¤êÅö¤Æ¤ëɬÍפ¬¤¢¤ë¡£
.PP
.\"O \fBvsnprintf\fP is the equivalent of \fBsnprintf\fP with the variable
.\"O argument list specified directly as for \fBvprintf\fP.
\fBvsnprintf\fP ´Ø¿ô¤Ï²ÄÊѤΰú¿ô¥ê¥¹¥È¤ò¤â¤Ã¤¿ \fBsnprintf\fP ¤ÈÅù²Á¤Ç¤¢¤ë¡£
°ú¿ô¥ê¥¹¥È¤Ë¤Ä¤¤¤Æ¤Ï \fBvprintf\fP ¤Î¹à¤ÇÀâÌÀ¤µ¤ì¤Æ¤¤¤ë¡£
.\"O .SH "RETURN VALUE"
.\"O If the output was truncated, the return value is -1, otherwise it is
.\"O the number of characters stored, not including the terminating null.
.\"O (Thus until glibc 2.0.6.  Since glibc 2.1 these functions
.\"O return the  number of characters (excluding the trailing null)
.\"O which would have been written to the final string if enough space
.\"O had been available.)
.SH ÊÖ¤êÃÍ
½ÐÎϤ¬Ä¹¤¯ÅÓÃæ¤Ç¥«¥Ã¥È¤µ¤ì¤¿¾ì¹ç¤Ë¤Ï -1 ¤òÊÖ¤·¡¢¤½¤ì°Ê³°¤Ï \fIstr\fP ¤ËÊݸ
¤µ¤ì¤¿Ê¸»ú¿ô(ʸ»úÎó¤Î½ªÃ¼¤ò¼¨¤¹'\e0'¤ò½ü¤¯)¤òÊÖ¤¹¡£
(⤷ glibc 2.0.6 ¤Þ¤Ç¤Î»ÅÍͤǤ¢¤ë¡£
glibc 2.1 °Ê¹ß¤Ç¤Ï¡¢¤³¤ì¤é¤Î´Ø¿ô¤Ï¡¢¤â¤·ÍøÍѲÄǽ¤Ê½½Ê¬¤Ê¥¹¥Ú¡¼¥¹¤¬¤¢¤ì¤Ð
½ñ¤­¹þ¤Þ¤ì¤¿¤Ç¤¢¤í¤¦Ê¸»ú¿ô(ʸ»úÎó¤Î½ªÃ¼¤ò¼¨¤¹'\e0'¤ò½ü¤¯)¤òÊÖ¤¹¡£)
.\"O .SH EXAMPLE
.SH Îã
.br
.\"O Here is an example program which dynamically enlarges its output buffer,
.\"O and works correctly under both glibc 2.0 and glibc 2.1.
½ÐÎϥХåե¡¤òưŪ¤Ë³ÈÄ¥¤¹¤ë¥×¥í¥°¥é¥àÎã¤ò°Ê²¼¤Ë¼¨¤¹¡£
¤³¤Î¥×¥í¥°¥é¥à¤Ï¡¢glibc 2.0 ¤È glibc 2.1 ¤Î¤É¤Á¤é¤Ç¤âÀµ¤·¤¯Æ°ºî¤¹¤ë¡£
.br
.sp
.nf
.\"O      /* Construct a message describing the value of a 
.\"O         variable whose name is NAME and whose value is 
.\"O         VALUE. */
    /* ÊÑ¿ô̾¤È¤½¤ÎÃͤòµ­½Ò¤¹¤ë "value of ÊÑ¿ô̾ is ÃÍ"
       ¤È¤¤¤¦¥á¥Ã¥»¡¼¥¸¤òºîÀ®¤¹¤ë´Ø¿ô */
    char *
    make_message (char *name, char *value)
    {
.\"O       /* Guess we need no more than 100 chars of space. */
      /* ½ÐÎϥХåե¡¤Ï100ʸ»úʬ¤Ç½½Ê¬¤Ç¤¢¤ë¤È²¾Äê */
      int size = 100;
      char *buffer = (char *) xmalloc (size);
      while (1)
        {
.\"O           /* Try to print in the allocated space. */
          /* ³ÎÊݺѤߤΥХåե¡¤Ë½ÐÎϤ·¤è¤¦¤È¤¹¤ë */
          int nchars = snprintf (buffer, size,
                        "value of %s is %s", name, value);
.\"O           /* If that worked, return the string. */
          /* À®¸ù¤¹¤ì¤Ð¡¢¥Ð¥Ã¥Õ¥¡Æâ¤Îʸ»úÎó¤òÊÖ¤¹ */
          if (nchars > -1 && nchars < size)
            return buffer;
.\"O           /* Else try again with more space. */
.\"O           if (nchars > -1)
.\"O             size = nchars+1;  /* precisely what is needed */
.\"O           else
.\"O             size *= 2;        /* twice the old size */
          /* ¼ºÇÔ¤¹¤ì¤Ð¡¢¤µ¤é¤Ë¥Ð¥Ã¥Õ¥¡¤ò³ÎÊݤ·¤ÆºÆ»î¹Ô */
          if (nchars > -1)
            size = nchars+1;  /* ɬÍפʥХåե¡Ä¹¤òÀµ³Î¤Ë³ÎÊÝ */
          else
            size *= 2;        /* ¥Ð¥Ã¥Õ¥¡Ä¹¤ò£²Çܤˤ¹¤ë */
          buffer = (char *) xrealloc (buffer, size);
        }
    }
.fi
.RE
.\"O .SH "CONFORMING TO"
.\"O These are GNU extensions, expected to become part of ISO C9x.
.SH ½àµò
¤³¤ì¤é¤Î´Ø¿ô¤Ï GNU ¤Ë¤è¤ë³ÈÄ¥¤Ç¤¢¤ë¡£ISO C9x ¤Î°ìÉô¤È¤Ê¤ëͽÄê¤Ç¤¢¤ë¡£
.\"O .SH "SEE ALSO"
.SH ´ØÏ¢¹àÌÜ
.BR printf "(3), " sprintf "(3), " vsprintf "(3), " stdarg (3)