Skip to content
This repository has been archived by the owner on Nov 14, 2019. It is now read-only.

Latest commit

 

History

History
74 lines (53 loc) · 1.66 KB

Write-ProgressBar.md

File metadata and controls

74 lines (53 loc) · 1.66 KB
external help file Module Name online version schema
PowerShellLib-help.xml
PowerShell-Lib
2.0.0

Write-ProgressBar

SYNOPSIS

Displays a progress bar.

SYNTAX

Write-ProgressBar [-PercentComplete] <Int32> [-Activity <String>] [<CommonParameters>]

DESCRIPTION

The "Write-ProgressBar" cmdlet displays a progress bar with a given progress percentage and a description of the currently running activity.

EXAMPLES

EXAMPLE 1

Write-ProgressBar -Activity "Checking ..." -PercentComplete $Index

PARAMETERS

-PercentComplete

The progress of the progress bar.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-Activity

A description of the activity that is running.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: Processing
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

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

INPUTS

OUTPUTS

NOTES

RELATED LINKS

https://github.com/Dargmuesli/PowerShell-Lib/blob/master/PowerShell-Lib/Docs/Write-ProgressBar.md