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

   1 '\" te
   2 .\"  Copyright (c) 1996, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" 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.
   4 .\" 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.
   5 .\" 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]
   6 .TH WSPRINTF 3C "Dec 29, 1996"
   7 .SH NAME
   8 wsprintf \- formatted output conversion
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <stdio.h>
  13 #include <widec.h>
  14
  15 \fBint\fR \fBwsprintf\fR(\fBwchar_t *\fR\fIs\fR, \fBconst char *\fR\fIformat\fR, \fB/*\fR \fIarg\fR */ ... ););
  16 .fi
  17
  18 .SH DESCRIPTION
  19 .sp
  20 .LP
  21 The \fBwsprintf()\fR function outputs a Process Code string ending with a
  22 Process Code (\fBwchar_t\fR) null character.  It is the user's responsibility
  23 to allocate enough space for this \fBwchar_t\fR string.
  24 .sp
  25 .LP
  26 This returns the number of Process Code characters (excluding the null
  27 terminator) that have been written. The conversion specifications and behavior
  28 of \fBwsprintf()\fR are the same as the regular \fBsprintf\fR(3C) function
  29 except that the result is a Process Code string for \fBwsprintf(\|),\fR and on
  30 Extended Unix Code (EUC) character string for \fBsprintf()\fR.
  31 .SH RETURN VALUES
  32 .sp
  33 .LP
  34 Upon successful completion, \fBwsprintf()\fR returns the number of characters
  35 printed. Otherwise, a negative value is returned.
  36 .SH ATTRIBUTES
  37 .sp
  38 .LP
  39 See \fBattributes\fR(5) for descriptions of the following attributes:
  40 .sp
  41
  42 .sp
  43 .TS
  44 box;
  45 c | c
  46 l | l .
  47 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  48 _
  49 MT-Level        MT-Safe
  50 .TE
  51
  52 .SH SEE ALSO
  53 .sp
  54 .LP
  55 \fBwsscanf\fR(3C), \fBprintf\fR(3C), \fBscanf\fR(3C), \fBsprintf\fR(3C),
  56 \fBattributes\fR(5)