Edit

Share via

New-ParameterInfo

  • Reference
Module:
Microsoft.PowerShell.Crescendo

Creates a PowerShell object representing a Crescendo Parameter definition.

Syntax

New-ParameterInfo
   [-Name] <String>
   [-OriginalName] <String>
   [<CommonParameters>]

Description

Creates a PowerShell object representing a Crescendo Parameter definition. You can assign values to the properties of the object. The resulting object can be added to the Parameters property of a command object or it can be converted to JSON to be inserted in the configuration file.

Examples

Example 1 - Create a new parameter object

$param = New-ParameterInfo -Name ComputerName -OriginalName '--targethost'
$param

Name                            : ComputerName
OriginalName                    : --targethost
OriginalText                    :
Description                     :
DefaultValue                    :
DefaultMissingValue             :
ApplyToExecutable               : False
ParameterType                   : object
AdditionalParameterAttributes   :
Mandatory                       : False
ParameterSetName                :
Aliases                         :
Position                        : 2147483647
OriginalPosition                : 0
ValueFromPipeline               : False
ValueFromPipelineByPropertyName : False
ValueFromRemainingArguments     : False
NoGap                           : False

Parameters

-Name

The name of the parameter for the cmdlet being defined.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-OriginalName

The original parameter used by the native executable.

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

Inputs

None

Outputs

Object