Delen via

Update-MarkdownCommandHelp

Module:
Microsoft.PowerShell.PlatyPS Module

Hiermee werkt u een geïmporteerd Markdown-opdrachtbestand bij met de informatie uit de sessie-cmdlet met dezelfde naam.

Syntaxis

Path (Standaard) 

Update-MarkdownCommandHelp
    [-Path] <string[]>
    [-NoBackup]
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

LiteralPath 

Update-MarkdownCommandHelp
    -LiteralPath <string[]>
    [-NoBackup]
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Met deze cmdlet importeert u een CommandHelp-object uit een Markdown-bestand en werkt u het object bij met de informatie uit de sessie-cmdlet met dezelfde naam en schrijft u het Markdown-bestand vervolgens opnieuw met de bijgewerkte informatie.

Voorbeelden

Voorbeeld 1

$mdfiles = Measure-PlatyPSMarkdown -Path .\v1\Microsoft.PowerShell.PlatyPS\*.md
$mdfiles | Where-Object Filetype -match 'CommandHelp' |
    Update-MarkdownCommandHelp -Path {$_.FilePath}

Parameters

-Confirm

Voordat u de cmdlet uitvoert, vraagt het systeem om bevestiging.

Parametereigenschappen

Type:SwitchParameter
Default value:False
Ondersteunt jokertekens:False
DontShow:False
Aliassen:Cf

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 Markdown-opdrachtbestanden. De waarde van LiteralPath- wordt precies 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:True
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-NoBackup

De cmdlet maakt standaard een back-up van het oorspronkelijke Markdown-bestand voordat u het bijwerkt. Gebruik deze parameter om het maken van het back-upbestand te onderdrukken.

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

-PassThru

Deze cmdlet genereert standaard geen uitvoer. Gebruik deze parameter om het bijgewerkte bestandsobject te retourneren.

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

-Path

Hiermee geeft u het pad naar een of meer Markdown-opdrachtbestand. Jokertekens zijn toegestaan.

Parametereigenschappen

Type:

String[]

Default value:None
Ondersteunt jokertekens:True
DontShow:False

Parametersets

Path
Position:0
Verplicht:True
Waarde uit pijplijn:True
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-WhatIf

Voert de opdracht uit in een modus die alleen rapporteert wat er zou gebeuren zonder de acties uit te voeren.

Parametereigenschappen

Type:SwitchParameter
Default value:False
Ondersteunt jokertekens:False
DontShow:False
Aliassen:Wi

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
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

FileInfo

Notities

Deze opdracht is vergelijkbaar met de Update-CommandHelp-cmdlet, maar het bron-Markdown-bestand wordt bijgewerkt.