Skip to content

Fixes #12414 - Update outputtype recommendations #12419

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 4 commits into from
Oct 6, 2025
Merged

Fixes #12414 - Update outputtype recommendations #12419

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
aedf063
Upcase H2 headers
sdwheeler Sep 24, 2025
dde700f
Fix structure of About files
sdwheeler Sep 24, 2025
96bb595
Update outputtype recommendations
sdwheeler Oct 6, 2025
3904898
Apply suggestions from code review
sdwheeler Oct 6, 2025
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
27 changes: 15 additions & 12 deletions ...ence/5.1/Microsoft.PowerShell.Core/About/about_Functions_OutputTypeAttribute.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Describes an attribute that reports the type of object that the function returns.
Locale: en-US
ms.date: 04/14/2023
ms.date: 10/06/2025
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_functions_outputtypeattribute?view=powershell-5.1&WT.mc_id=ps-gethelp
schema: 2.0.0
title: about_Functions_OutputTypeAttribute
Expand All @@ -16,19 +16,22 @@ returns.
## Long description

The **OutputType** attribute lists the .NET types of objects that the functions
returns. You can use its optional ParameterSetName parameter to list different
output types for each parameter set.
returns. You can use its optional **ParameterSetName** parameter to list
different output types for each parameter set.

The **OutputType** attribute is supported on simple and advanced functions.
It's independent of the **CmdletBinding** attribute.
It's independent of the **CmdletBinding** attribute. The **OutputType**
attribute provides the value of the **OutputType** property of the
**System.Management.Automation.FunctionInfo** object that the `Get-Command`
cmdlet returns.

The **OutputType** attribute provides the value of the **OutputType** property
of the **System.Management.Automation.FunctionInfo** object that the
`Get-Command` cmdlet returns.
> [!NOTE]
> The **OutputType** attribute value isn't derived from the function code or
> compared to the actual function output. As such, the value might be
> inaccurate.

The **OutputType** attribute value is only a documentation note. It's not
derived from the function code or compared to the actual function output. As
such, the value might be inaccurate.
The **OutputType** attribute also informs tab completion results for situations
like: `Command | Select <Tab>` and `Command | Where <Tab>`.

## Syntax

Expand Down Expand Up @@ -235,8 +238,8 @@ Or its shorter version.
```

The value of the **OutputType** property can be null. Use a null value when the
output isn't a .NET type, such as a **WMI** object or a formatted view of an
object.
function doesn't write any output to the **Success** stream. If the function
writes output, but you don't know the type, use **System.Object**.

## See also

Expand Down
27 changes: 15 additions & 12 deletions ...ence/7.4/Microsoft.PowerShell.Core/About/about_Functions_OutputTypeAttribute.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Describes an attribute that reports the type of object that the function returns.
Locale: en-US
ms.date: 04/14/2023
ms.date: 10/06/2025
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_functions_outputtypeattribute?view=powershell-7.4&WT.mc_id=ps-gethelp
schema: 2.0.0
title: about_Functions_OutputTypeAttribute
Expand All @@ -16,19 +16,22 @@ returns.
## Long description

The **OutputType** attribute lists the .NET types of objects that the functions
returns. You can use its optional ParameterSetName parameter to list different
output types for each parameter set.
returns. You can use its optional **ParameterSetName** parameter to list
different output types for each parameter set.

The **OutputType** attribute is supported on simple and advanced functions.
It's independent of the **CmdletBinding** attribute.
It's independent of the **CmdletBinding** attribute. The **OutputType**
attribute provides the value of the **OutputType** property of the
**System.Management.Automation.FunctionInfo** object that the `Get-Command`
cmdlet returns.

The **OutputType** attribute provides the value of the **OutputType** property
of the **System.Management.Automation.FunctionInfo** object that the
`Get-Command` cmdlet returns.
> [!NOTE]
> The **OutputType** attribute value isn't derived from the function code or
> compared to the actual function output. As such, the value might be
> inaccurate.

The **OutputType** attribute value is only a documentation note. It's not
derived from the function code or compared to the actual function output. As
such, the value might be inaccurate.
The **OutputType** attribute also informs tab completion results for situations
like: `Command | Select <Tab>` and `Command | Where <Tab>`.

## Syntax

Expand Down Expand Up @@ -235,8 +238,8 @@ Or its shorter version.
```

The value of the **OutputType** property can be null. Use a null value when the
output isn't a .NET type, such as a **WMI** object or a formatted view of an
object.
function doesn't write any output to the **Success** stream. If the function
writes output, but you don't know the type, use **System.Object**.

## See also

Expand Down
27 changes: 15 additions & 12 deletions ...ence/7.5/Microsoft.PowerShell.Core/About/about_Functions_OutputTypeAttribute.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Describes an attribute that reports the type of object that the function returns.
Locale: en-US
ms.date: 04/14/2023
ms.date: 10/06/2025
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_functions_outputtypeattribute?view=powershell-7.5&WT.mc_id=ps-gethelp
schema: 2.0.0
title: about_Functions_OutputTypeAttribute
Expand All @@ -16,19 +16,22 @@ returns.
## Long description

The **OutputType** attribute lists the .NET types of objects that the functions
returns. You can use its optional ParameterSetName parameter to list different
output types for each parameter set.
returns. You can use its optional **ParameterSetName** parameter to list
different output types for each parameter set.

The **OutputType** attribute is supported on simple and advanced functions.
It's independent of the **CmdletBinding** attribute.
It's independent of the **CmdletBinding** attribute. The **OutputType**
attribute provides the value of the **OutputType** property of the
**System.Management.Automation.FunctionInfo** object that the `Get-Command`
cmdlet returns.

The **OutputType** attribute provides the value of the **OutputType** property
of the **System.Management.Automation.FunctionInfo** object that the
`Get-Command` cmdlet returns.
> [!NOTE]
> The **OutputType** attribute value isn't derived from the function code or
> compared to the actual function output. As such, the value might be
> inaccurate.

The **OutputType** attribute value is only a documentation note. It's not
derived from the function code or compared to the actual function output. As
such, the value might be inaccurate.
The **OutputType** attribute also informs tab completion results for situations
like: `Command | Select <Tab>` and `Command | Where <Tab>`.

## Syntax

Expand Down Expand Up @@ -235,8 +238,8 @@ Or its shorter version.
```

The value of the **OutputType** property can be null. Use a null value when the
output isn't a .NET type, such as a **WMI** object or a formatted view of an
object.
function doesn't write any output to the **Success** stream. If the function
writes output, but you don't know the type, use **System.Object**.

## See also

Expand Down
27 changes: 15 additions & 12 deletions ...ence/7.6/Microsoft.PowerShell.Core/About/about_Functions_OutputTypeAttribute.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Describes an attribute that reports the type of object that the function returns.
Locale: en-US
ms.date: 04/14/2023
ms.date: 10/06/2025
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_functions_outputtypeattribute?view=powershell-7.6&WT.mc_id=ps-gethelp
schema: 2.0.0
title: about_Functions_OutputTypeAttribute
Expand All @@ -16,19 +16,22 @@ returns.
## Long description

The **OutputType** attribute lists the .NET types of objects that the functions
returns. You can use its optional ParameterSetName parameter to list different
output types for each parameter set.
returns. You can use its optional **ParameterSetName** parameter to list
different output types for each parameter set.

The **OutputType** attribute is supported on simple and advanced functions.
It's independent of the **CmdletBinding** attribute.
It's independent of the **CmdletBinding** attribute. The **OutputType**
attribute provides the value of the **OutputType** property of the
**System.Management.Automation.FunctionInfo** object that the `Get-Command`
cmdlet returns.

The **OutputType** attribute provides the value of the **OutputType** property
of the **System.Management.Automation.FunctionInfo** object that the
`Get-Command` cmdlet returns.
> [!NOTE]
> The **OutputType** attribute value isn't derived from the function code or
> compared to the actual function output. As such, the value might be
> inaccurate.

The **OutputType** attribute value is only a documentation note. It's not
derived from the function code or compared to the actual function output. As
such, the value might be inaccurate.
The **OutputType** attribute also informs tab completion results for situations
like: `Command | Select <Tab>` and `Command | Where <Tab>`.

## Syntax

Expand Down Expand Up @@ -235,8 +238,8 @@ Or its shorter version.
```

The value of the **OutputType** property can be null. Use a null value when the
output isn't a .NET type, such as a **WMI** object or a formatted view of an
object.
function doesn't write any output to the **Success** stream. If the function
writes output, but you don't know the type, use **System.Object**.

## See also

Expand Down