Click or drag to resize

SI2ToScaledString(Int64, Int32, String, String, Int64, Int64) Method

Turns the given number of units (e.g., bytes) into a textual representation with an appropriate unit scaling and common named representation (e.g., KB, MB, GB, TB, etc.).

Namespace: GSF.Units
Assembly: GSF.Core (in GSF.Core.dll) Version: 2.4.207-beta+1781b796b2aa7a54013a031eb432fe4ccee31867
Syntax
public static string ToScaledString(
	long totalUnits,
	int decimalPlaces,
	string unitName,
	string[] symbolNames = null,
	long minimumFactor = 1024,
	long maximumFactor = 1152921504606846976
)
View Source

Parameters

totalUnits  Int64
Total units to represent textually.
decimalPlaces  Int32
Number of decimal places to display.
unitName  String
Name of unit display (e.g., you could use "B" for bytes).
symbolNames  String  (Optional)
Optional SI factor symbol or name array to use during textual conversion, defaults to Symbols.
minimumFactor  Int64  (Optional)
Optional minimum SI factor. Defaults to Kilo.
maximumFactor  Int64  (Optional)
Optional maximum SI factor. Defaults to Exa.

Return Value

String
A String representation of the number of units.
Exceptions
ExceptionCondition
ArgumentOutOfRangeExceptiondecimalPlaces cannot be negative.
ArgumentOutOfRangeExceptionminimumFactor or maximumFactor is not defined in Factors array.
Remarks
The symbolNames array needs one string entry for each defined SI item ordered from least (Kilo) to greatest (Exa), see Names or Symbols arrays for examples.
See Also