Edit

Share via

New-ExampleInfo

  • Reference
Module:
Microsoft.PowerShell.Crescendo

Creates a PowerShell object representing an example used in a Crescendo command object.

Syntax

New-ExampleInfo
   [-command] <String>
   [-description] <String>
   [[-originalCommand] <String>]
   [<CommonParameters>]

Description

Creates a PowerShell object representing an example used in a Crescendo command object. The resulting object can be converted to JSON to be inserted into a configuration file or added to a command object conversion to JSON later.

Examples

Example 1

New-ExampleInfo -command Get-Something -originalCommand native.exe -description 'this is some text' |
    ConvertTo-Json

{
  "Command": "Get-Something",
  "OriginalCommand": "native.exe",
  "Description": "this is some text"
}

Parameters

-command

The command line for the example being described.

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

-description

The description of the example.

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

-originalCommand

The original native command that's run for this cmdlet example.

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

Inputs

None

Outputs

Object