share/man/man3c/wsscanf.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 WSSCANF 3C "Dec 29, 1996"
   7 .SH NAME
   8 wsscanf \- formatted input conversion
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include<stdio.h>
  13 #include <widec.h>
  14
  15 \fBint\fR \fBwsscanf\fR(\fBwchar_t *\fR\fIs\fR, \fBconst char *\fR\fIformat\fR, \fB/*\fR \fIpointer\fR */ ... );
  16 .fi
  17
  18 .SH DESCRIPTION
  19 .sp
  20 .LP
  21 The \fBwsscanf()\fR function reads Process Code characters from the Process
  22 Code string \fIs\fR, interprets them according to the \fIformat\fR, and stores
  23 the results in its arguments.  It expects, as arguments, a control string
  24 \fIformat\fR, and a set of \fIpointer\fR arguments indicating where the
  25 converted input should be stored. The results are undefined if there are
  26 insufficient \fIarg\fRs for the format.  If the format is exhausted while
  27 \fIarg\fRs remain, the excess \fIarg\fRs are simply ignored.
  28 .sp
  29 .LP
  30 The conversion specifications and behavior of \fBwsscanf()\fR are the same as
  31 the regular \fBsscanf\fR(3C) function except that the source is a Process Code
  32 string for \fBwsscanf()\fR and on Extended Unix Code (EUC) character string for
  33 \fBsscanf\fR(3C).
  34 .SH RETURN VALUES
  35 .sp
  36 .LP
  37 Upon successful completion, \fBwsscanf()\fR returns the number of characters
  38 matched. Otherwise, it returns a negative value.
  39 .SH ATTRIBUTES
  40 .sp
  41 .LP
  42 See \fBattributes\fR(5) for descriptions of the following attributes:
  43 .sp
  44
  45 .sp
  46 .TS
  47 box;
  48 c | c
  49 l | l .
  50 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  51 _
  52 MT-Level        MT-Safe
  53 .TE
  54
  55 .SH SEE ALSO
  56 .sp
  57 .LP
  58 \fBwsprintf\fR(3C), \fBprintf\fR(3C), \fBscanf\fR(3C), \fBattributes\fR(5)