Import-YamlCommandHelp
Hiermee importeert u Help-inhoud van Yaml in CommandHelp-objecten.
Syntaxis
Path (Standaard)
Import-YamlCommandHelp
[-Path] <string[]>
[-AsDictionary]
[<CommonParameters>]
LiteralPath
Import-YamlCommandHelp
-LiteralPath <string[]>
[-AsDictionary]
[<CommonParameters>]
Description
Met de opdracht importeert u Yaml-bestanden met help-opdrachten en maakt u CommandHelp--objecten. Het CommandHelp-object is een gestructureerde weergave van de Help-inhoud die kan worden gebruikt voor het exporteren naar verschillende indelingen.
Voorbeelden
Voorbeeld 1: alle Yaml-cmdlet-bestanden in een map importeren
In het volgende voorbeeld worden Markdown-cmdlet-bestanden in een map geïmporteerd en geconverteerd naar CommandHelp--objecten. Deze objecten kunnen worden gebruikt om te exporteren naar verschillende indelingen.
Import-YamlCommandHelp -Path .\v2\yaml\*-*.yml | Select-Object Title
Title
-----
Compare-CommandHelp
Export-MamlCommandHelp
Export-MarkdownCommandHelp
Export-MarkdownModuleFile
Export-YamlCommandHelp
Export-YamlModuleFile
Import-MamlHelp
Import-MarkdownCommandHelp
Import-MarkdownModuleFile
Import-YamlCommandHelp
Import-YamlModuleFile
Measure-PlatyPSMarkdown
New-CommandHelp
New-MarkdownCommandHelp
New-MarkdownModuleFile
Test-MarkdownCommandHelp
Update-CommandHelp
Update-MarkdownCommandHelp
Update-MarkdownModuleFile
Parameters
-AsDictionary
Deze cmdlet retourneert standaard CommandHelp--objecten. Wanneer u deze parameter gebruikt. de cmdlet retourneert dezelfde informatie als een OrderedDictionary-object.
Parametereigenschappen
| Type: | SwitchParameter |
| Default value: | False |
| Ondersteunt jokertekens: | False |
| DontShow: | False |
Parametersets
(All)
| Position: | Named |
| Verplicht: | False |
| Waarde uit pijplijn: | False |
| Waarde uit pijplijn op eigenschapsnaam: | False |
| Waarde van resterende argumenten: | False |
-LiteralPath
Hiermee geeft u een pad naar een of meer Yaml-opdrachtbestanden. De waarde van LiteralPath wordt exact gebruikt zoals deze is getypt. Er worden geen tekens geïnterpreteerd als jokertekens. Als het pad escape-tekens bevat, zet het dan tussen enkele aanhalingstekens. Enkele aanhalingstekens zorgen ervoor dat PowerShell geen tekens als escapesequenties interpreteert.
Zie about_Quoting_Rulesvoor meer informatie.
Parametereigenschappen
| Type: | String[] |
| Default value: | None |
| Ondersteunt jokertekens: | False |
| DontShow: | False |
| Aliassen: | PSPath, LP |
Parametersets
LiteralPath
| Position: | Named |
| Verplicht: | True |
| Waarde uit pijplijn: | False |
| Waarde uit pijplijn op eigenschapsnaam: | False |
| Waarde van resterende argumenten: | False |
-Path
Het pad naar het Yaml-opdrachtbestand. Specificeert een pad naar een of meer locaties.
Parametereigenschappen
| Type: | String[] |
| Default value: | None |
| Ondersteunt jokertekens: | True |
| DontShow: | False |
| Aliassen: | Volledige naam |
Parametersets
Path
| Position: | 0 |
| Verplicht: | True |
| Waarde uit pijplijn: | True |
| Waarde uit pijplijn op eigenschapsnaam: | True |
| Waarde van resterende argumenten: | False |
CommonParameters
Deze cmdlet ondersteunt de algemene parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction en -WarningVariable. Zie about_CommonParametersvoor meer informatie.
Invoerwaarden
String
Uitvoerwaarden
OrderedDictionary
Met deze cmdlet wordt een OrderedDictionary--object geretourneerd wanneer u de parameter AsDictionary gebruikt.
Microsoft.PowerShell.PlatyPS.Model.CommandHelp
Deze cmdlet retourneert standaard CommandHelp--objecten.