BinarySizeParse(String, BinarySizeOptions, NumberStyles, IFormatProvider) Method

public static BinarySize Parse(
	string s,
	BinarySizeOptions options = BinarySizeOptions.Default,
	NumberStyles style = NumberStyles.Number,
	IFormatProvider? provider = null
)

Public Shared Function Parse ( 
	s As String,
	Optional options As BinarySizeOptions = BinarySizeOptions.Default,
	Optional style As NumberStyles = NumberStyles.Number,
	Optional provider As IFormatProvider = Nothing
) As BinarySize

public:
static BinarySize Parse(
	String^ s, 
	BinarySizeOptions options = BinarySizeOptions::Default, 
	NumberStyles style = NumberStyles::Number, 
	IFormatProvider^ provider = nullptr
)

static member Parse : 
        s : string * 
        ?options : BinarySizeOptions * 
        ?style : NumberStyles * 
        ?provider : IFormatProvider 
(* Defaults:
        let _options = defaultArg options BinarySizeOptions.Default
        let _style = defaultArg style NumberStyles.Number
        let _provider = defaultArg provider null
*)
-> BinarySize 

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

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 any surrounding whitespace is ignored.

Depending on the value of options, the use of long units may also be allowed: "byte", "kilobyte", "kibibyte", "megabyte", "mebibyte", "gigabyte", "gibibyte", "terabyte", "tebibyte", "petabyte", "pebibyte", "exabyte", or "exbibyte". The "byte" suffix may be ommitted, and may also be the plural "bytes", regardless of whether the number is actually plural or not.

The units listed above are the default, invariant units based on the English language. You can parse localized units by using the BinaryUnitInfo class with the provider parameter, either directly or together with a CultureInfo object through the CultureInfoExtensionsWithBinaryUnitInfo(CultureInfo, BinaryUnitInfo) method.

The case of the units in s is ignored by default. Use the BinaryUnitInfoCompareOptions property to customize how units are matched.

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.

Reference