FormatDate: generate a date string based on a date formatting template. (V38)

FormatDate(locale,fmtTemplate,date,putCharFunc);

A0 A1 A2 A3

VOID FormatDate(struct Locale *,STRPTR,struct DateStamp *,

struct Hook *);

This function processes a formatting template and generates a stream of bytes that's sent one character at a time to the putCharFunc callback hook.

locale: the locale to use for the formatting
fmtTemplate: the NULL-terminated template describing the desired format for the date. This is constructed just like C-language printf() statements, except that different formatting codes are used. Just like in C, formatting codes start with a % followed by the formatting command. The following commands are accepted by this function:

%a - abbreviated weekday name
%-a - abbreviated weekday name, first letter lowercase
%+a - abbreviated weekday name, first letter uppercase
%^a - abbreviated weekday name, all letters uppercase
%A - weekday name
%-A - weekday name, first letter lowercase
%+A - weekday name, first letter uppercase
%^A - weekday name, all letters uppercase
%<A - alternate weekday name, first letter lowercase
%>A - alternate weekday name, first letter uppercase
%b - abbreviated month name
%-b - abbreviated month name, first letter lowercase
%+b - abbreviated month name, first letter uppercase
%^b - abbreviated month name, all letters uppercase
%B - month name
%-B - month name, first letter lowercase
%+B - month name, first letter uppercase
%^B - month name, all letters uppercase
%<B - alternate month name, first letter lowercase
%>B - alternate month name, first letter uppercase
%c - same as "%a %b %d %H:%M:%S %Y"
%C - century (year / 100) with leading zeros (00-99)
%-C - century (year / 100) without leading zeros (0-99)
%d - day number with leading zeros (01-31)
%-d - day number without leading zeros (1-31)
%D - same as "%m/%d/%y"
%e - day number with leading spaces ( 1-31)
%F - same as "%Y-%m-%d", ISO 8601 date format
%g - week based year as specified in ISO 8601,

taking Monday as first day of the week,
using two digits with leading zeros (00-99)

%-g - week based year as specified in ISO 8601,

taking Monday as first day of the week,
using two digits without leading zeros (0-99)

%G - week based year as specified in ISO 8601,

taking Monday as first day of the week,
using four digits with leading zeros

%-G - week based year as specified in ISO 8601,

taking Monday as first day of the week,
using four digits without leading zeros

%h - abbreviated month name
%-h - abbreviated month name, first letter lowercase
%+h - abbreviated month name, first letter uppercase
%^h - abbreviated month name, all letters uppercase
%H - hour using 24-hour style with leading zeros

(00-23)

%I - hour using 12-hour style with leading zeros

(01-12)

%j - julian date with leading zeros (001-366)
%-j - julian date without leading zeros (1-366)
%J - remaining days of the year with leading zeros
%-J - remaining days of the year without leading zeros
%m - month number with leading zeros (01-12)
%-m - month number without leading zeros (1-12)
%M - the number of minutes with leading zeros (00-59)
%-M - the number of minutes without leading zeros

(0-59)

%n - insert a linefeed
%p - AM or PM strings
%-p - AM or PM strings, first letter lowercase
%+p - AM or PM strings, first letter uppercase
%^p - AM or PM strings, all letters uppercase
%q - hour using 24-hour style without leading zeros

(0-23)

%Q - hour using 12-hour style without leading zeros

(1-12)

%r - same as "%I:%M:%S %p"
%R - same as "%H:%M"
%S - number of seconds with leadings zeros (00-60)
%-S - number of seconds without leadings zeros (0-60)
%t - insert a tab character
%T - same as "%H:%M:%S"
%u - week day number (1-7), taking Monday as first day

of the week as specified in ISO 8601

%U - week number, taking the first Sunday of the year

as first day of week 1, with leading zeros
(00-53)

%-U - like %U but without leading zeros (0-53)
%V - week number (01-53), taking Monday as first day

of the week as specified in ISO 8601

%-V - like %V but without leading zeros (1-53)
%w - weekday number
%W - week number, taking the first Monday of the year

as first day of week 1, with leading zeros
(00-53)

%-W - like %W but without leading zeros (0-53)
%x - same as "%m/%d/%y"
%X - same as "%H:%M:%S"
%y - year using two digits with leading zeros (00-99)
%-y - year using two digits without leading zeros

(0-99)

%Y - year using four digits with leading zeros
%-Y - year using four digits without leading zeros
%z - time zone offset to UTC as specified in

ISO 8601, using a '-' sign for time zone offsets
behind UTC (west of Greenwhich), a '+' sign
otherwise, then two digits for the hours
and two digits for the minutes

%Z - time zone name or abbreviation. "UTC" for now,

may be localized in future

%% - a single '%' character

The variants starting with %-, %+, %^, %< and %> were added in V50.

The %< and %> alternate weekday and month names were added in V50 for better support of languages where the name used alone differs from the name used in a date string, e.g. czech, finnish, slovak. If the language driver does not provide alternate weekday or month names for usage inside of date strings, the normal versions for standalone usage are used.

Before V51.11 "%C" was defined to be equal to "%a %b %e %T %Z %Y" but that did never work because "%Z" was not defined. Now it's the century for compatibility to ISO C99 strftime().

In V51.11, "%g", "%-g", "%F", "%G", "%-G", "%u", "%V", "z" and "%Z" were added, "%U" and "%W" were slightly changed for compatibility to ISO C99 strftime().

If the template parameter is NULL, a single NUL byte is sent to putCharFunc.
date: the date to format into a string.
putCharFunc: a callback hook invoked for every character generated, including for the terminating NUL character. The hook function is called with:

A0 - address of Hook structure
A2 - locale pointer
A1 - character for hook to process (not a pointer!)

ParseDate(), <libraries/locale.h>, <dos/dos.h>

NAME

SYNOPSIS

FUNCTION

INPUTS

SEE ALSO