CauBaseCommand.ShouldDoIt Method (String, String, String, Boolean)

 

Requests confirmation from the user before an operation is performed. This method combines the ShouldProcess and ShouldContinue methods.

Namespace:   Microsoft.ClusterAwareUpdating.Commands
Assembly:  ClusterAwareUpdating (in ClusterAwareUpdating.dll)

Syntax

protected bool ShouldDoIt(
    string verboseDescription,
    string verboseWarning,
    string caption,
    bool force
)

protected:
bool ShouldDoIt(
    String^ verboseDescription,
    String^ verboseWarning,
    String^ caption,
    bool force
)

member ShouldDoIt : 
        verboseDescription:string *
        verboseWarning:string *
        caption:string *
        force:bool -> bool

Protected Function ShouldDoIt (
    verboseDescription As String,
    verboseWarning As String,
    caption As String,
    force As Boolean
) As Boolean

Parameters

• verboseDescription
  Type: System.String

  A description of the operation to be performed. This description is displayed to the user when a warning message is not specified, when the WhatIf parameter is used when the command is called, or when the ErrorActionPreference shell variable is set to Continue.

• verboseWarning
  Type: System.String

  A warning message that contains a query asking whether the operation should be performed. This warning message is displayed to the user when the ErrorActionPreference shell variable is set to Inquire.

• caption
  Type: System.String

  A caption that is displayed above the query. This caption can also displayed in a window that might, or might not, be displayed by specific hosts.

• force
  Type: System.Boolean

  Indicates whether to bypass the confirmation performed by the ShouldProcess method.

Return Value

Type: System.Boolean

A Boolean value that is true if the cmdlet should perform the action; false, otherwise.

See Also

CauBaseCommand Class
Microsoft.ClusterAwareUpdating.Commands Namespace

Return to top