New ArgumentException

New-ArgumentException

SYNOPSIS

Creates and throws or returns an invalid argument exception.

SYNTAX

New-ArgumentException [-Message] <String> [-ArgumentName] <String> [-PassThru]
 [<CommonParameters>]

DESCRIPTION

Creates and throws or returns an invalid argument exception.

EXAMPLES

EXAMPLE 1

New-ArgumentException -ArgumentName 'Action' -Message 'My error message'

Creates and throws an invalid argument exception for (parameter) 'Action' with the message 'My error message'.

EXAMPLE 2

$errorRecord = New-ArgumentException -ArgumentName 'Action' -Message 'My error message' -PassThru

Creates an invalid argument exception for (parameter) 'Action' with the message 'My error message' and returns the exception.

PARAMETERS

-ArgumentName

The name of the invalid argument that is causing this error to be thrown.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Message

The message explaining why this error is being thrown.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PassThru

If specified, returns the error record instead of throwing it.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
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.

INPUTS

OUTPUTS

None

System.ArgumentException

NOTES

RELATED LINKS