Share via

PSDefaultValueAttribute Class

  • Reference

Definition

Namespace:
System.Management.Automation
Assembly:
System.Management.Automation.dll
Package:
Microsoft.PowerShell.5.1.ReferenceAssemblies v1.0.0
Package:
System.Management.Automation v7.0.13
Package:
System.Management.Automation v7.1.7
Package:
System.Management.Automation v7.2.12
Package:
System.Management.Automation v7.3.5
Package:
System.Management.Automation v7.4.0
Package:
Microsoft.WSMan.Runtime v6.1.0
Package:
Microsoft.WSMan.Runtime v6.2.0

Specify a default value and/or help comment for a command parameter. This attribute does not have any semantic meaning, it is simply an aid to tools to make it simpler to know the true default value of a command parameter (which may or may not have any correlation with, e.g., the backing store of the Parameter's property or field.

public ref class PSDefaultValueAttribute sealed : System::Management::Automation::Internal::ParsingBaseAttribute
[System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Property)]
public sealed class PSDefaultValueAttribute : System.Management.Automation.Internal.ParsingBaseAttribute
[<System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Property)>]
type PSDefaultValueAttribute = class
    inherit ParsingBaseAttribute
Public NotInheritable Class PSDefaultValueAttribute
Inherits ParsingBaseAttribute
Inheritance
Attribute
CmdletMetadataAttribute
ParsingBaseAttribute
PSDefaultValueAttribute
Attributes
AttributeUsageAttribute

Constructors

PSDefaultValueAttribute()

Properties

Help

Specify the help string for the default value of a command parameter.
Value

Specify the default value of a command parameter. The PowerShell engine does not use this value in any way, it exists for other tools that want to reflect on cmdlets.

Applies to