Invoke-ShouldProcess

NAME Invoke-ShouldProcess



SYNOPSIS

Invokes $PSCmdlet.ShouldProcess





SYNTAX

Invoke-ShouldProcess [[-ContinueMessage] <String>] [[-InquireMessage] <String>] [[-Caption] <String>] [[-Script]

<ScriptBlock>] [-WhatIf] [-Confirm] [<CommonParameters>]





DESCRIPTION





PARAMETERS

-ContinueMessage <String>

Textual description of the action to be performed. This is what will be displayed to the user for

ActionPreference.Continue.



Required? false

Position? 1

Default value

Accept pipeline input? false

Accept wildcard characters? false



-InquireMessage <String>

Textual query of whether the action should be performed, usually in the form of a question. This is what will

be displayed to the user for ActionPreference.Inquire.



Required? false

Position? 2

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Caption <String>

Caption of the window which may be displayed if the user is prompted whether or not to perform the action.

(Caption may be displayed by some hosts, but not all.)



Required? false

Position? 3

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Script <ScriptBlock>

The script executed if the $PSCmdlet.ShouldProcess returns true.



Required? false

Position? 4

Default value

Accept pipeline input? false

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Confirm [<SwitchParameter>]



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS





RELATED LINKS





CommonParameters : False

WorkflowCommonParameters : False

details : @{name=Join-Path; noun=; verb=}

Syntax : @{syntaxItem=System.Object[]}

parameters : @{parameter=System.Object[]}

inputTypes : @{inputType=}

returnValues : @{returnValue=}

aliases : None



remarks : None

alertSet :

description :

examples :

Synopsis :

Join-Path



ModuleName : IntelliTect.Common

nonTerminatingErrors :

xmlns:command : http://schemas.microsoft.com/maml/dev/command/2004/10

xmlns:dev : http://schemas.microsoft.com/maml/dev/2004/10

xmlns:maml : http://schemas.microsoft.com/maml/2004/10

Name : Join-Path

Category : Function

Component :

Role :

Functionality :





examples : @{example=System.Management.Automation.PSObject[]}

inputTypes : @{inputType=@{type=@{name=System.String}; description=System.Management.Automation.PSObject[]}}

alertSet : @{alert=System.Management.Automation.PSObject[]}

syntax : @{syntaxItem=@{name=Join-Path; parameter=System.Management.Automation.PSObject[]}}

parameters : @{parameter=System.Management.Automation.PSObject[]}

details : @{description=System.Management.Automation.PSObject[]; verb=Join; noun=Path; name=Join-Path}

description : {@{Text=The Join-Path cmdlet combines a path and child-path into a single path. The provider supplies

the path delimiters.}}

relatedLinks : @{navigationLink=System.Management.Automation.PSObject[]}

returnValues : @{returnValue=@{type=@{name=System.String}; description=System.Management.Automation.PSObject[]}}

xmlns:maml : http://schemas.microsoft.com/maml/2004/10

xmlns:command : http://schemas.microsoft.com/maml/dev/command/2004/10

xmlns:dev : http://schemas.microsoft.com/maml/dev/2004/10

xmlns:MSHelp : http://msdn.microsoft.com/mshelp

Name : Join-Path

Category : Cmdlet

Synopsis : Combines a path and a child path into a single path.

Component :

Role :

Functionality :

PSSnapIn :

ModuleName : Microsoft.PowerShell.Management