Skip to content

Fix the example of Format-Custom -DisplayError #1849

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 10, 2017
Merged

Fix the example of Format-Custom -DisplayError #1849

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 13 additions & 8 deletions reference/3.0/Microsoft.PowerShell.Utility/Format-Custom.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,14 +56,19 @@ Accept wildcard characters: False
```

### -DisplayError
Displays errors at the command line.
This parameter is rarely used, but can be used as a debugging aid when you are formatting expressions in a Format-Custom command, and the expressions do not appear to be working.
The following shows an example of the results of adding the DisplayError parameter with an expression.

PS \> Get-Date | Format-Custom DayOfWeek,{ $_ / $null } -ShowError
DayOfWeek $_ / $null
--------- ------------
Wednesday #ERR
Indicates that this cmdlet displays errors at the command line.
This parameter is rarely used, but can be used as a debugging aid when you are formatting expressions in a `Format-Custom` command, and the expressions do not appear to be working.
The following shows an example of the results of adding the **DisplayError** parameter with an expression.

```powershell
PS C:\> Get-Date | Format-Custom DayOfWeek, { $_ / $null } -DisplayError

class DateTime
{
DayOfWeek = Wednesday
$_ / $null = #ERR
}
```

```yaml
Type: SwitchParameter
Expand Down
21 changes: 13 additions & 8 deletions reference/4.0/Microsoft.PowerShell.Utility/Format-Custom.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,14 +61,19 @@ Accept wildcard characters: False
```

### -DisplayError
Displays errors at the command line.
This parameter is rarely used, but can be used as a debugging aid when you are formatting expressions in a Format-Custom command, and the expressions do not appear to be working.
The following shows an example of the results of adding the DisplayError parameter with an expression.

PS \> Get-Date | Format-Custom DayOfWeek,{ $_ / $null } -ShowError
DayOfWeek $_ / $null
--------- ------------
Wednesday #ERR
Indicates that this cmdlet displays errors at the command line.
This parameter is rarely used, but can be used as a debugging aid when you are formatting expressions in a `Format-Custom` command, and the expressions do not appear to be working.
The following shows an example of the results of adding the **DisplayError** parameter with an expression.

```powershell
PS C:\> Get-Date | Format-Custom DayOfWeek, { $_ / $null } -DisplayError

class DateTime
{
DayOfWeek = Wednesday
$_ / $null = #ERR
}
```

```yaml
Type: SwitchParameter
Expand Down
16 changes: 10 additions & 6 deletions reference/5.0/Microsoft.PowerShell.Utility/Format-Custom.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,14 +62,18 @@ Accept wildcard characters: False

### -DisplayError
Indicates that this cmdlet displays errors at the command line.
This parameter is rarely used, but can be used as a debugging aid when you are formatting expressions in a **Format-Custom** command, and the expressions do not appear to be working.
The following shows an example of the results of adding the *DisplayError* parameter with an expression.
This parameter is rarely used, but can be used as a debugging aid when you are formatting expressions in a `Format-Custom` command, and the expressions do not appear to be working.
The following shows an example of the results of adding the **DisplayError** parameter with an expression.

`PS \> Get-Date | Format-Custom DayOfWeek,{ $_ / $null } -ShowError`
```powershell
PS C:\> Get-Date | Format-Custom DayOfWeek, { $_ / $null } -DisplayError

`DayOfWeek $_ / $null`
`--------- ------------`
`Wednesday #ERR`
class DateTime
{
DayOfWeek = Wednesday
$_ / $null = #ERR
}
```

```yaml
Type: SwitchParameter
Expand Down
16 changes: 10 additions & 6 deletions reference/5.1/Microsoft.PowerShell.Utility/Format-Custom.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,14 +62,18 @@ Accept wildcard characters: False

### -DisplayError
Indicates that this cmdlet displays errors at the command line.
This parameter is rarely used, but can be used as a debugging aid when you are formatting expressions in a **Format-Custom** command, and the expressions do not appear to be working.
The following shows an example of the results of adding the *DisplayError* parameter with an expression.
This parameter is rarely used, but can be used as a debugging aid when you are formatting expressions in a `Format-Custom` command, and the expressions do not appear to be working.
The following shows an example of the results of adding the **DisplayError** parameter with an expression.

`PS \> Get-Date | Format-Custom DayOfWeek,{ $_ / $null } -ShowError`
```powershell
PS C:\> Get-Date | Format-Custom DayOfWeek, { $_ / $null } -DisplayError

`DayOfWeek $_ / $null`
`--------- ------------`
`Wednesday #ERR`
class DateTime
{
DayOfWeek = Wednesday
$_ / $null = #ERR
}
```

```yaml
Type: SwitchParameter
Expand Down
16 changes: 10 additions & 6 deletions reference/6/Microsoft.PowerShell.Utility/Format-Custom.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,14 +63,18 @@ Accept wildcard characters: False

### -DisplayError
Indicates that this cmdlet displays errors at the command line.
This parameter is rarely used, but can be used as a debugging aid when you are formatting expressions in a **Format-Custom** command, and the expressions do not appear to be working.
The following shows an example of the results of adding the *DisplayError* parameter with an expression.
This parameter is rarely used, but can be used as a debugging aid when you are formatting expressions in a `Format-Custom` command, and the expressions do not appear to be working.
The following shows an example of the results of adding the **DisplayError** parameter with an expression.

`PS \> Get-Date | Format-Custom DayOfWeek,{ $_ / $null } -ShowError`
```powershell
PS C:\> Get-Date | Format-Custom DayOfWeek, { $_ / $null } -DisplayError

`DayOfWeek $_ / $null`
`--------- ------------`
`Wednesday #ERR`
class DateTime
{
DayOfWeek = Wednesday
$_ / $null = #ERR
}
```

```yaml
Type: SwitchParameter
Expand Down