TextFormat.LegibleSize Method (UInt64, Int32, Int32, LegibleSizeFormat)

 

Displays a nonnegative byte amount, up to the exabyte (EB) level, as a text string in the specified format with the specified number of rounding decimal digits and a maximum length.

Namespace:   Microsoft.WindowsServerSolutions.Common
Assembly:  AdminCommon (in AdminCommon.dll)

Syntax

public static string LegibleSize(
    ulong sizeInBytes,
    int decimalPlaces,
    int maxLength,
    LegibleSizeFormat sizeFormat
)

public:
static String^ LegibleSize(
    unsigned long long sizeInBytes,
    int decimalPlaces,
    int maxLength,
    LegibleSizeFormat sizeFormat
)

Public Shared Function LegibleSize (
    sizeInBytes As ULong,
    decimalPlaces As Integer,
    maxLength As Integer,
    sizeFormat As LegibleSizeFormat
) As String

Parameters

• sizeInBytes
  Type: System.UInt64

  The byte amount.

• decimalPlaces
  Type: System.Int32

  The number of rounding decimal digits.

• maxLength
  Type: System.Int32

  The maximum length of the resulting text string.

• sizeFormat
  Type: Microsoft.WindowsServerSolutions.Common.LegibleSizeFormat

  One of the LegibleSizeFormat enumeration values that represents the size format to be used.

Return Value

Type: System.String

A System.String.

See Also

LegibleSize Overload
TextFormat Class
Microsoft.WindowsServerSolutions.Common Namespace

Return to top