Delen via

New-UsageInfo

  • Referentie
Module:
Microsoft.PowerShell.Crescendo

Hiermee maakt u een PowerShell-object dat een crescendo-gebruiksdefinitie vertegenwoordigt.

Syntaxis

New-UsageInfo
   [-usage] <String>
   [<CommonParameters>]

Description

Hiermee maakt u een PowerShell-object dat een crescendo-gebruiksdefinitie vertegenwoordigt. U kunt waarden toewijzen aan de eigenschappen van het object. Het resulterende object kan worden toegevoegd aan de eigenschap Usage van een opdrachtobject of kan worden geconverteerd naar JSON om in het configuratiebestand in te voegen. De Synopsis- van het object wordt in de module ingevoegd als hulp op basis van opmerkingen onder het trefwoord .SYNOPSIS.

Voorbeelden

Voorbeeld 1: Een gebruiksobject maken en converteren naar JSON

$usage = New-UsageInfo -usage 'This is a description for how to use the cmdlet.'
$usage | ConvertTo-Json

{
  "Synopsis": "This is a description for how to use the cmdlet.",
  "SupportsFlags": false,
  "HasOptions": false,
  "OriginalText": null
}

Parameters

-usage

De tekst die het doel van de cmdlet beschrijft.

Type:String
Position:0
Default value:None
Vereist:True
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

Invoerwaarden

None

Uitvoerwaarden

Object