Invoke-Progress
SYNOPSIS
{{ Fill in the Synopsis }}
SYNTAX
Invoke-Progress [[-Id] <Int32>] [[-Activity] <String>] [[-Status] <String>] [-Get] <ScriptBlock>
[-Process] <ScriptBlock> [[-Format] <ScriptBlock>] [[-FailedProcessItem] <ScriptBlock>]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
DESCRIPTION
{{ Fill in the Description }}
EXAMPLES
Example 1
PS C:\> {{ Add example code here }}
{{ Add example description here }}
PARAMETERS
-Activity
The activity to display in the progress bar.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-FailedProcessItem
The ScriptBlock to invoke when an item fails to process.
Type: ScriptBlock
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Format
The ScriptBlock that formats the items name for the progress bar.
Type: ScriptBlock
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Get
The ScriptBlock which returns the items to process.
Type: ScriptBlock
Parameter Sets: (All)
Aliases:
Required: True
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Id
The ID of the progress bar, used to display multiple progress bars at once.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Process
The ScriptBlock to process each item.
Type: ScriptBlock
Parameter Sets: (All)
Aliases:
Required: True
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Status
The status message to display in the progress bar.
This is formatted with three placeholders:
The current completion percentage.
The index of the item being processed.
The total number of items being processed.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ProgressAction
{{ Fill ProgressAction Description }}
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga
Required: False
Position: Named
Default value: None
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.