Private/Progress.ps1

<#PSScriptInfo

.VERSION 1.0.5

.GUID d410b890-4003-4030-8a47-ee4b5d91a254

.AUTHOR Jason Cook

.COMPANYNAME Tectic

.COPYRIGHT Copyright (c) Tectic 2024

.TAGS

.LICENSEURI

.PROJECTURI

.ICONURI

.EXTERNALMODULEDEPENDENCIES

.REQUIREDSCRIPTS

.EXTERNALSCRIPTDEPENDENCIES

.RELEASENOTES

#>


<#
.DESCRIPTION
Show progress in an easier to use format
#>

# SkipLoadDefaults: true
param(
  [int]$Index,
  [int]$Total,
  [string]$Name,
  [string]$Activity,
  [string]$Status = ("Processing {0} of {1}: {2}" -f $Index, $Total, $Name),
  [int]$PercentComplete = ($Index / $Total * 100)
)

if ($PercentComplete -eq 100) { $Completed = $true } else { $Completed = $false }
if ($Total -gt 1) { Write-Progress -Activity $Activity -Status $Status -PercentComplete $PercentComplete -Completed:$Completed }