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

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

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

.SH PARAMS
\fIlcid\fR \fB[In]\fR  Locale to format for.
.PP
\fIdwFlags\fR \fB[In]\fR  \fBLOCALE_\fR and \fBTIME_\fR flags from \fB"winnls.h"\fR.
.PP
\fIlpTime\fR \fB[In]\fR  Time to format.
.PP
\fIlpFormat\fR \fB[In]\fR  Formatting overrides.
.PP
\fIlpTimeStr\fR \fB[Out]\fR  Destination for formatted string.
.PP
\fIcchOut\fR \fB[In]\fR  Size of \fIlpTimeStr\fR, or \fB0\fR to calculate the resulting size.
.PP

.SH NOTES
.PP
\fB-\fR If \fIlpFormat\fR is \fBNULL\fR, lpszValue 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 \fIlpTimeStr\fR, with tokens being replaced by the time values they represent. 
.PP
\fB-\fR The following tokens have special meanings in a time format string: 
.br
  Token  Meaning
.br
  -----  -------
.br
  h      Hours with no leading zero (12-hour clock)
.br
  hh     Hours with full two digits (12-hour clock)
.br
  H      Hours with no leading zero (24-hour clock)
.br
  HH     Hours with full two digits (24-hour clock)
.br
  m      Minutes with no leading zero
.br
  mm     Minutes with full two digits
.br
  s      Seconds with no leading zero
.br
  ss     Seconds with full two digits
.br
  t      Short time marker (e.g. "A" or "P")
.br
  tt     Long time marker (e.g. "AM", "PM")
.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 \fIlpTimeStr\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.