doc/ctime.texi

   1 @node ctime
   2 @section ctime
   3 @findex ctime
   4
   5 @c Copyright (C) 2005, 2009-2013 Free Software Foundation, Inc.
   6
   7 @c Permission is granted to copy, distribute and/or modify this document
   8 @c under the terms of the GNU Free Documentation License, Version 1.3 or
   9 @c any later version published by the Free Software Foundation; with no
  10 @c Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
  11 @c Texts.  A copy of the license is included in the ``GNU Free
  12 @c Documentation License'' file as part of this distribution.
  13
  14 The @code{ctime} function need not be reentrant, and consequently is
  15 not required to be thread safe.  Implementations of @code{ctime}
  16 typically write the time stamp into static buffer.  If two threads
  17 call @code{ctime} at roughly the same time, you might end up with the
  18 wrong date in one of the threads, or some undefined string.  There is
  19 a re-entrant interface @code{ctime_r}, that take a pre-allocated
  20 buffer and length of the buffer, and return @code{NULL} on errors.
  21 The input buffer should be at least 26 bytes in size.  The output
  22 string is locale-independent.  However, years can have more than 4
  23 digits if @code{time_t} is sufficiently wide, so the length of the
  24 required output buffer is not easy to determine.  Increasing the
  25 buffer size when @code{ctime_r} return @code{NULL} is not necessarily
  26 sufficient. The @code{NULL} return value could mean some other error
  27 condition, which will not go away by increasing the buffer size.
  28
  29 A more flexible function is @code{strftime}.  However, note that it is
  30 locale dependent.