CFLib.org – Common Function Library Project

HMSFormat(time[, type][, mask][, displayMS])

Last updated May 14, 2002

author

Pascal Peters

Version: 1 | Requires: CF5 | Library: StrLib

Description:
Returns a formatted time difference. The time can be in hours, minutes, seconds or milliseconds (default). You can specify an optional mask (HH: hours; MM:minutes; SS:seconds). Returns the unformatted string if the time is not numeric.

Return Values:
Returns a string.

Example:

<cfoutput>
<table border="1">
<tr>
	<td>123456 ms</td>
	<td>#HMSFormat(123456)#</td>
</tr>
<tr>
	<td>13.123456 h</td>
	<td>#HMSFormat(13.123456,"h","HH hours MM min SS sec")#</td>
</tr>
<tr>
	<td>-12.5 min</td>
	<td>#HMSFormat(-12.5,"m","HH:MM:SS",true)#</td>
</tr>
<tr>
	<td>aa</td>
	<td>#HMSFormat("aa")#</td>
</tr>
</table>
</cfoutput>

Parameters:

Name Description Required
time An integer representing a time duration. Yes
type The type of the time duration. Defaults to milliseconds. No
mask Mask for HSMFormat. Defaults to "HH:MM:SS" No
displayMS Boolean to display milliseconds. Defaults to false. No

Full UDF Source:

/**
 * Formats a time difference in hours, minutes and seconds.
 * 
 * @param time 	 An integer representing a time duration. (Required)
 * @param type 	 The type of the time duration. Defaults to milliseconds. (Optional)
 * @param mask 	 Mask for HSMFormat. Defaults to "HH:MM:SS" (Optional)
 * @param displayMS 	 Boolean to display milliseconds. Defaults to false. (Optional)
 * @return Returns a string. 
 * @author Pascal Peters (ppeters@lrt.be) 
 * @version 1, May 14, 2002 
 */
function HMSFormat(time) {
	var str = "";
	var tmptime = 0;
	var h = 0;
	var m = 0;
	var s = 0;
	var sign = "";
	// default values for optional parameters
	var type = "ms";
	var mask = "HH:MM:SS";
	var displayMs = false;
	
	if(ArrayLen(Arguments) gte 2) type = Arguments[2];
	if(ArrayLen(Arguments) gte 3) mask = Arguments[3];
	if(ArrayLen(Arguments) gte 4) displayMs = Arguments[4];
	
	if(not IsNumeric(time)) return time;
	if(time lt 0){
		time = Abs(time);
		sign = "-";
	} 
	
	switch(type){
	case "h":
		h = int(time);
		tmptime = (time - h)*60;
		m = int(tmptime);
		s = (tmptime - m)*60;
		break;
	case "m":
		h = int(time/60);
		tmptime = time - h*60;
		m = int(tmptime);
		s = (tmptime - m)*60;
		break;
	case "s":
		h = int(time/3600);
		tmptime = time - h*3600;
		m = int(tmptime/60);
		s = tmptime - m*60;
		break;
	default:
		h = int(time/3600000);
		tmptime = time - h*3600000;
		m = int(tmptime/60000);
		tmptime = tmptime - m*60000;
		s = tmptime/1000;
		break;
	}
	
	m = NumberFormat(m,"00");
	if(displayMs) s = NumberFormat(s,"00.000");
	else s = NumberFormat(Round(s),"00");
	str = Replace(mask,"HH",sign & h,"ALL");
	str = Replace(str,"MM",m,"ALL");
	str = Replace(str,"SS",s,"ALL");

	return str;
}
blog comments powered by Disqus

Search CFLib.org


Latest Additions

Kevin Cotton added
date2ExcelDate
May 5, 2016

Raymond Camden added
CapFirst
April 25, 2016

Chris Wigginton added
loremIpsum
January 18, 2016

Gary Stanton added
calculateArrival...
November 19, 2015

Sebastiaan Naafs - van Dijk added
getDaysInQuarter
November 13, 2015

Created by Raymond Camden / Design by Justin Johnson