Click or drag to resize

TimeToElapsedTimeString Method

Converts total seconds into a textual representation of years, days, hours, minutes and seconds with the specified number of fractional digits given string array of time names.

Namespace: GSF.Units
Assembly: GSF.Core (in GSF.Core.dll) Version: 2.4.181-beta
Syntax
public static string ToElapsedTimeString(
	double seconds,
	int secondPrecision,
	string[] timeNames = null,
	double minimumSubSecondResolution = 0.001
)
View Source

Parameters

seconds  Double
Seconds to convert to elapsed time.
secondPrecision  Int32
Number of fractional digits to display for seconds.
timeNames  String  (Optional)
Time names array to use during textual conversion.
minimumSubSecondResolution  Double  (Optional)
Minimum sub-second resolution to display. Defaults to Milli.

Return Value

String
The string representation of the value of this instance, consisting of the number of years, days, hours, minutes and seconds represented by this value.
Exceptions
ExceptionCondition
ArgumentOutOfRangeExceptionminimumSubSecondResolution is not less than or equal to Milli or minimumSubSecondResolution is not defined in Factors array.
Remarks

Set secondPrecision to -1 to suppress seconds display, this will force minimum resolution of time display to minutes.

timeNames array needs one string entry for each of the following names:
" year", " years", " day", " days", " hour", " hours", " minute", " minutes", " second", " seconds", "less than ".

See Also