BinarySizeParse(String, BinarySizeOptions, NumberStyles, IFormatProvider) Method

Parses a string into a BinarySize structure.

Definition

Namespace: Ookii
Assembly: Ookii.BinarySize (in Ookii.BinarySize.dll) Version: 1.0.0+877c9712c6435bf9adfdb0683d7a434c5604a8f2
C#
public static BinarySize Parse(
	string s,
	BinarySizeOptions options = BinarySizeOptions.Default,
	NumberStyles style = NumberStyles.Number,
	IFormatProvider? provider = null
)

Parameters

s  String
The string to parse.
options  BinarySizeOptions  (Optional)
A bitwise combination of BinarySizeOptions values that indicates how multi-byte units in s are interpreted.
style  NumberStyles  (Optional)
A bitwise combination of NumberStyles values that indicates the style elements that can be present in s. A typical value is NumberStylesNumber.
provider  IFormatProvider  (Optional)
An object that provides culture-specific formatting information about s.

Return Value

BinarySize
The result of parsing s.

Remarks

The input must contain a number, followed by one of the following units: "B", "KB", "KiB", "MB", "MiB", "GB", "GiB", "TB", "TiB", "PB", "PiB", "EB", or "EiB". The "B" may be omitted, and the casing of the unit and any surrounding whitespace is ignored.

The size of 1 KiB always equals 1024 bytes, and 1 MiB is 1,048,576 bytes, and so on.

By default, this method also treats 1 KB as 1,024 bytes, identical to 1 KiB, and 1 MB equals 1 MiB equals 1,048,576 bytes, and so on.

When options includes the BinarySizeOptionsUseIecStandard flag, the SI prefixes (those without an 'i') are treated as powers of ten, so that 1 kB equals 1,000 bytes, 1 MB == 1,000,000 bytes, and so on. The IEC prefixes are unchanged, and remain based on powers of two.

The value of options is not stored in the instance, and will therefore not affect the output when converting back to a string. Use an appropriate format string with the ToString(String, IFormatProvider) method if you wish to use decimal prefixes there as well.

Exceptions

ArgumentNullExceptions is .
ArgumentExceptionoptions is not valid.
FormatExceptions is not in the correct format.
OverflowExceptions is not representable as a BinarySize.

See Also