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

.SH NAME
\fBStrFromTimeIntervalA\fR (SHLWAPI.@)
.SH SYNOPSIS
INT StrFromTimeIntervalA
 (
  LPSTR \fIlpszStr\fR,
  UINT  \fIcchMax\fR,
  DWORD \fIdwMS\fR,
  int   \fIiDigits\fR
 )

.SH DESCRIPTION
.PP
Format a millisecond time interval into a string. 

.SH PARAMS
\fIlpszStr\fR \fB[Out]\fR  Output buffer for formatted time interval.
.PP
\fIcchMax\fR \fB[In]\fR  Size of \fIlpszStr\fR.
.PP
\fIdwMS\fR \fB[In]\fR  Number of milliseconds.
.PP
\fIiDigits\fR \fB[In]\fR  Number of digits to print.
.PP

.SH RETURNS
.PP
The length of the formatted string, or \fB0\fR if any parameter is invalid. 

.SH NOTES
.PP
This implementation mimics the Win32 behaviour of always writing a leading space before the time interval begins. 
.PP
\fIiDigits\fR is used to provide approximate times if accuracy is not important. This number of digits will be written of the first non-zero time class (hours/minutes/seconds). If this does not complete the time classification, the remaining digits are changed to zeros (i.e. The time is _not_ rounded). If there are digits remaining following the writing of a time class, the next time class will be written. 
.PP
For example, given \fIdwMS\fR represents \fB138\fR hours,43 minutes and \fB15\fR seconds, the following will result from the given values of iDigits: 
.br
  iDigits    1        2        3        4               5               ...
.br
  lpszStr   "100 hr" "130 hr" "138 hr" "138 hr 40 min" "138 hr 43 min"  ...

.SH IMPLEMENTATION
.PP
Declared in \fB"shlwapi.h"\fR. 
.PP
Implemented in \fB"dlls/shlwapi/string.c"\fR. 
.PP
Debug channel \fB"shell"\fR.