.\" -*- nroff -*-
.\" Generated file - DO NOT EDIT!
.TH GetDateFormatA 3w "Oct 2012" "Wine API" "Wine API"

.SH NAME
\fBGetDateFormatA\fR (KERNEL32.@)
.SH SYNOPSIS
INT GetDateFormatA
 (
  LCID              \fIlcid\fR,
  DWORD             \fIdwFlags\fR,
  const SYSTEMTIME* \fIlpTime\fR,
  LPCSTR            \fIlpFormat\fR,
  LPSTR             \fIlpDateStr\fR,
  INT               \fIcchOut\fR
 )

.SH DESCRIPTION
.PP
Format a date for a given locale. 

.SH PARAMS
\fIlcid\fR \fB[In]\fR  Locale to format for.
.PP
\fIdwFlags\fR \fB[In]\fR  \fBLOCALE_\fR and \fBDATE_\fR flags from \fB"winnls.h"\fR.
.PP
\fIlpTime\fR \fB[In]\fR  Date to format.
.PP
\fIlpFormat\fR \fB[In]\fR  Format string, or \fBNULL\fR to use the system defaults.
.PP
\fIlpDateStr\fR \fB[Out]\fR  Destination for formatted string.
.PP
\fIcchOut\fR \fB[In]\fR  Size of \fIlpDateStr\fR, or \fB0\fR to calculate the resulting size.
.PP

.SH NOTES
.PP
\fB-\fR If \fIlpFormat\fR is \fBNULL\fR, \fIlpDateStr\fR will be formatted according to the format details returned by \fBGetLocaleInfoA(3w)\fR and modified by \fIdwFlags\fR. 
.PP
\fB-\fR \fIlpFormat\fR is a string of characters and formatting tokens. Any characters in the string are copied verbatim to \fIlpDateStr\fR, with tokens being replaced by the date values they represent. 
.PP
\fB-\fR The following tokens have special meanings in a date format string: 
.br
  Token  Meaning
.br
  -----  -------
.br
  d      Single digit day of the month (no leading 0)
.br
  dd     Double digit day of the month
.br
  ddd    Short name for the day of the week
.br
  dddd   Long name for the day of the week
.br
  M      Single digit month of the year (no leading 0)
.br
  MM     Double digit month of the year
.br
  MMM    Short name for the month of the year
.br
  MMMM   Long name for the month of the year
.br
  y      Double digit year number (no leading 0)
.br
  yy     Double digit year number
.br
  yyyy   Four digit year number
.br
  gg     Era string, for example 'AD'.
.PP
\fB-\fR To output any literal character that could be misidentified as a token, enclose it in single quotes. 
.PP
\fB-\fR The Ascii version of this function fails if \fIlcid\fR is Unicode only. 

.SH RETURNS
.PP
\fBSuccess:\fR The number of character written to \fIlpDateStr\fR, or that would have been written, if \fIcchOut\fR is \fB0.\fR 
.PP
\fBFailure:\fR \fB0.\fR Use \fBGetLastError(3w)\fR to determine the cause. 

.SH IMPLEMENTATION
.PP
Declared in \fB"winnls.h"\fR. 
.PP
Implemented in \fB"dlls/kernel32/lcformat.c"\fR. 
.PP
Debug channel \fB"nls"\fR.