Skip to content
This repository has been archived by the owner on Dec 15, 2020. It is now read-only.

Latest commit

 

History

History
84 lines (51 loc) · 2.07 KB

HelpersFormatFileSize.md

File metadata and controls

84 lines (51 loc) · 2.07 KB

Format-FileSize

DO NOT USE. Not part of the public API.

Syntax

Format-FileSize `
  -Size <Double> `
  [-IgnoredArguments <Object[]>] [<CommonParameters>]

Description

Formats file size into a human readable format.

Notes

Available in 0.9.10+.

This function is not part of the API.

Aliases

None

Examples

EXAMPLE 1

Format-FileSize -Size $fileSizeBytes

Inputs

None

Outputs

None

Parameters

-Size <Double>

The size of a file in bytes.

Property Value
Aliases
Required? true
Position? 1
Default Value 0
Accept Pipeline Input? false

-IgnoredArguments [<Object[]>]

Allows splatting with arguments that do not apply. Do not use directly.

Property Value
Aliases
Required? false
Position? named
Default Value
Accept Pipeline Input? false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters http://go.microsoft.com/fwlink/p/?LinkID=113216 .

Links

  • [[Get-WebFile|HelpersGetWebFile]]

[[Function Reference|HelpersReference]]

NOTE: This documentation has been automatically generated from Import-Module "$env:ChocolateyInstall\helpers\chocolateyInstaller.psm1" -Force; Get-Help Format-FileSize -Full.

View the source for Format-FileSize