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.

Definition

Namespace: Gemstone.Units
Assembly: Gemstone.Common (in Gemstone.Common.dll) Version: 1.0.128 -- Release Build+d050cfc5563c89a1188cc3c6b2d417530856f490

C#View Source Request Example

public static string ToElapsedTimeString(
	double seconds,
	int secondPrecision,
	string[]? timeNames = null,
	double minimumSubSecondResolution = 0.001
)

VBView Source Request Example

Public Shared Function ToElapsedTimeString ( 
	seconds As Double,
	secondPrecision As Integer,
	Optional timeNames As String() = Nothing,
	Optional minimumSubSecondResolution As Double = 0.001
) As String

C++View Source Request Example

public:
static String^ ToElapsedTimeString(
	double seconds, 
	int secondPrecision, 
	array<String^>^ timeNames = nullptr, 
	double minimumSubSecondResolution = 0.001
)

JavaScriptView Source Request Example

Gemstone.Units.Time.ToElapsedTimeString = function(seconds, secondPrecision, timeNames, minimumSubSecondResolution);

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.

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 ".

Exceptions

ArgumentOutOfRangeException

minimumSubSecondResolution is not less than or equal to Milli or minimumSubSecondResolution is not defined in Factors array.