usr/src/man/man3c/vfwprintf.3c

   1 '\" te
   2 .\" Copyright (c) 1992, X/Open Company Limited. All Rights Reserved.  Portions Copyright (c) 1998, Sun Microsystems, Inc.  All Rights Reserved.
   3 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
   4 .\" http://www.opengroup.org/bookstore/.
   5 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
   6 .\"  This notice shall appear on any product containing this material.
   7 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   8 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   9 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
  10 .TH VFWPRINTF 3C "Nov 1, 2003"
  11 .SH NAME
  12 vfwprintf, vswprintf, vwprintf \- wide-character formatted output of a stdarg
  13 argument list
  14 .SH SYNOPSIS
  15 .LP
  16 .nf
  17 #include <stdarg.h>
  18 #include <stdio.h>
  19 #include <wchar.h>
  20
  21 \fBint\fR \fBvfwprintf\fR(\fBFILE *restrict\fR \fIstream\fR, \fBconst wchar_t *restrict\fR \fIformat\fR,
  22      \fBva_list\fR \fIarg\fR);
  23 .fi
  24
  25 .LP
  26 .nf
  27 \fBint\fR \fBvswprintf\fR(\fBwchar_t *restrict\fR \fIs\fR, \fBsize_t\fR \fIn\fR,
  28      \fBconst wchar_t *restrict\fR \fIformat\fR, \fBva_list\fR \fIarg\fR);
  29 .fi
  30
  31 .LP
  32 .nf
  33 \fBint\fR \fBvwprintf\fR(\fBconst wchar_t *restrict\fR \fIformat\fR, \fBva_list\fR \fIarg\fR);
  34 .fi
  35
  36 .SH DESCRIPTION
  37 .sp
  38 .LP
  39 The \fBvwprintf()\fR, \fBvfwprintf()\fR, and \fBvswprintf()\fR functions are
  40 the same as \fBwprintf()\fR, \fBfwprintf()\fR, and \fBswprintf()\fR
  41 respectively, except that instead of being called with a variable number of
  42 arguments, they are called with an argument list as defined by
  43 <\fBstdarg.h\fR>.
  44 .sp
  45 .LP
  46 These functions do not invoke the  \fBva_end()\fR macro.  However, as these
  47 functions do invoke the \fBva_arg()\fR macro, the value of \fIap\fR after the
  48 return is indeterminate.
  49 .SH RETURN VALUES
  50 .sp
  51 .LP
  52 Refer to  \fBfwprintf\fR(3C).
  53 .SH ERRORS
  54 .sp
  55 .LP
  56 Refer to  \fBfwprintf\fR(3C).
  57 .SH USAGE
  58 .sp
  59 .LP
  60 Applications using these functions should call \fBva_end(\fR\fIap\fR\fB)\fR
  61 afterwards to clean up.
  62 .SH ATTRIBUTES
  63 .sp
  64 .LP
  65 See \fBattributes\fR(5) for descriptions of the following attributes:
  66 .sp
  67
  68 .sp
  69 .TS
  70 box;
  71 c | c
  72 l | l .
  73 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  74 _
  75 Interface Stability     Standard
  76 _
  77 MT-Level        MT-Safe with exceptions
  78 .TE
  79
  80 .SH SEE ALSO
  81 .sp
  82 .LP
  83 \fBfwprintf\fR(3C), \fBsetlocale\fR(3C), \fBattributes\fR(5),
  84 \fBstandards\fR(5)
  85 .SH NOTES
  86 .sp
  87 .LP
  88 The \fBvwprintf()\fR, \fBvfwprintf()\fR, and \fBvswprintf()\fR functions can be
  89 used safely in multithreaded applications, as long as \fBsetlocale\fR(3C) is
  90 not being called to change the locale.