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

   1 '\" te
   2 .\" Copyright (c) 1992, X/Open Company Limited.  All Rights Reserved.  Portions Copyright (c) 2003, 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 WCSFTIME 3C "Nov 1, 2003"
  11 .SH NAME
  12 wcsftime \- convert date and time to wide character string
  13 .SH SYNOPSIS
  14 .LP
  15 .nf
  16 #include <wchar.h>
  17 .fi
  18
  19 .SS "XPG4 and SUS"
  20 .LP
  21 .nf
  22 \fBsize_t\fR \fBwcsftime\fR(\fBwchar_t *\fR\fIwcs\fR, \fBsize_t\fR \fImaxsize\fR, \fBconst char *\fR\fIformat\fR,
  23      \fBconst struct tm *\fR\fItimptr\fR);
  24 .fi
  25
  26 .SS "Default and other standards"
  27 .LP
  28 .nf
  29 \fBsize_t\fR \fBwcsftime\fR(\fBwchar_t *restrict\fR \fIwcs\fR, \fBsize_t\fR \fImaxsize\fR,
  30      \fBconst wchar_t *restrict\fR \fIformat\fR,
  31      \fBconst struct tm *restrict\fR \fItimptr\fR);
  32 .fi
  33
  34 .SH DESCRIPTION
  35 .sp
  36 .LP
  37 The \fBwcsftime()\fR function is equivalent to the \fBstrftime\fR(3C) function,
  38 except that:
  39 .RS +4
  40 .TP
  41 .ie t \(bu
  42 .el o
  43 The argument \fIwcs\fR points to the initial element of an array of
  44 wide-characters into which the generated output is to be placed.
  45 .RE
  46 .RS +4
  47 .TP
  48 .ie t \(bu
  49 .el o
  50 The argument \fImaxsize\fR indicates the maximum number of wide-characters to
  51 be placed in the output array.
  52 .RE
  53 .RS +4
  54 .TP
  55 .ie t \(bu
  56 .el o
  57 The argument \fIformat\fR is a wide-character string and the conversion
  58 specifications are  replaced by corresponding sequences of wide-characters.
  59 .RE
  60 .RS +4
  61 .TP
  62 .ie t \(bu
  63 .el o
  64 The return value indicates the number of wide-characters placed in the output
  65 array.
  66 .RE
  67 .sp
  68 .LP
  69 If copying takes place between objects that overlap, the behavior is undefined.
  70 .SH RETURN VALUES
  71 .sp
  72 .LP
  73 If the total number of resulting wide character  codes (including the
  74 terminating null wide-character code) is no more than \fImaxsize\fR,
  75 \fBwcsftime()\fR returns the number of wide-character codes  placed into the
  76 array pointed to by \fIwcs\fR, not including the terminating null
  77 wide-character code. Otherwise, \fB0\fR is returned and the contents of the
  78 array are indeterminate.
  79 .sp
  80 .LP
  81 The \fBwcfstime()\fR function uses \fBmalloc\fR(3C) and should \fBmalloc()\fR
  82 fail, \fBerrno\fR will be set by \fBmalloc()\fR.
  83 .SH ATTRIBUTES
  84 .sp
  85 .LP
  86 See \fBattributes\fR(5) for descriptions of the following attributes:
  87 .sp
  88
  89 .sp
  90 .TS
  91 box;
  92 l | l
  93 l | l .
  94 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  95 _
  96 CSI     Enabled
  97 _
  98 Interface Stability     Standard
  99 _
 100 MT-Level        MT-Safe with exceptions
 101 .TE
 102
 103 .SH SEE ALSO
 104 .sp
 105 .LP
 106 \fBmalloc\fR(3C), \fBsetlocale\fR(3C), \fBstrftime\fR(3C), \fBattributes\fR(5),
 107 \fBstandards\fR(5)
 108 .SH NOTES
 109 .sp
 110 .LP
 111 The \fBwcsftime()\fR function can be used safely in multithreaded applications,
 112 as long as \fBsetlocale\fR(3C) is not being called to change the locale.