locale/FreeBSD/wcsftime.3

   1 .\" Copyright (c) 2002 Tim J. Robbins
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD: src/lib/libc/locale/wcsftime.3,v 1.2 2002/11/29 17:35:09 ru Exp $
  26 .\"
  27 .Dd September 8, 2002
  28 .Dt WCSFTIME 3
  29 .Os
  30 .Sh NAME
  31 .Nm wcsftime ,
  32 .Nm wcsftime_l
  33 .Nd "convert date and time to a wide-character string"
  34 .Sh LIBRARY
  35 .Lb libc
  36 .Sh SYNOPSIS
  37 .In wchar.h
  38 .Ft size_t
  39 .Fo wcsftime
  40 .Fa "wchar_t *restrict wcs"
  41 .Fa "size_t maxsize"
  42 .Fa "const wchar_t *restrict format"
  43 .Fa "const struct tm *restrict timeptr"
  44 .Fc
  45 .In wchar.h
  46 .In xlocale.h
  47 .Ft size_t
  48 .Fo wcsftime_l
  49 .Fa "wchar_t *restrict wcs"
  50 .Fa "size_t maxsize"
  51 .Fa "const wchar_t *restrict format"
  52 .Fa "const struct tm *restrict timeptr"
  53 .Fa "locale_t loc"
  54 .Fc
  55 .Sh DESCRIPTION
  56 The
  57 .Fn wcsftime
  58 function is equivalent to the
  59 .Fn strftime
  60 function, except for the types of its arguments.
  61 Refer to
  62 .Xr strftime 3
  63 for a detailed description.
  64 .Pp
  65 While the
  66 .Fn wcsftime
  67 function uses the current locale, the
  68 .Fn wcsftime_l
  69 function may be passed a locale directly. See
  70 .Xr xlocale 3
  71 for more information.
  72 .Sh COMPATIBILITY
  73 Some early implementations of
  74 .Fn wcsftime
  75 had a
  76 .Fa format
  77 argument with type
  78 .Vt "const char *" ,
  79 instead of
  80 .Vt "const wchar_t *" .
  81 .Sh SEE ALSO
  82 .Xr strftime 3 ,
  83 .Xr xlocale 3
  84 .Sh STANDARDS
  85 The
  86 .Fn wcsftime
  87 function conforms to
  88 .St -isoC-99 .