Exit-PpCommandObsolete

SYNOPSIS

Set error code that the command is obsolete.

SYNTAX

__AllParameterSets

Exit-PpCommandObsolete [[-ExitMessage] <string>] [<CommonParameters>]

ALIASES

This cmdlet has the following aliases,

DESCRIPTION

Uses the Exit-PpScript that comes from PSlib.psm1, to set the package error.

EXAMPLES

EXAMPLE 1

Exit-PpCommandObsolete

EXAMPLE 2

Exit-PpCommandObsolete -ExitMessage “This command is obsolete.”

PARAMETERS

-ExitMessage

Exit message to display.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
  Position: 0
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

Custom command.