Dela via

Update-CommandHelp

Modul:
Microsoft.PowerShell.PlatyPS Module

Uppdaterar ett importerat CommandHelp- objekt med informationen från sessions-cmdleten med samma namn.

Syntax

Path (Standard) 

Update-CommandHelp
    [-Path] <string[]>
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

LiteralPath 

Update-CommandHelp
    -LiteralPath <string[]>
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Den här cmdleten importerar ett CommandHelp--objekt från en Markdown-fil och uppdaterar objektet med informationen från sessions-cmdleten med samma namn. Det uppdaterade objektet kan sedan exporteras på nytt för att uppdatera markdown-källfilen.

Exempel

Exempel 1

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

19

Parametrar

-Confirm

Uppmanar dig att bekräfta innan du kör cmdleten.

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:False
Stöder jokertecken:False
DontShow:False
Alias:jfr

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-LiteralPath

Anger en sökväg till en eller flera markdown-kommandofiler. Värdet för LiteralPath- används exakt som det skrivs. Inga tecken tolkas som wildcards. Om sökvägen innehåller escape-tecken omger du den med enkla citattecken. Enkla citattecken gör att PowerShell inte tolkar några tecken som escape-sekvenser.

Mer information finns i about_Quoting_Rules.

Parameteregenskaper

Typ:

String[]

Standardvärde:None
Stöder jokertecken:False
DontShow:False
Alias:PSPath, SP

Parameteruppsättningar

LiteralPath
Position:Named
Obligatorisk:True
Värde från pipeline:True
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-Path

Anger sökvägen till en eller flera Markdown-kommandofiler. Jokertecken tillåts.

Parameteregenskaper

Typ:

String[]

Standardvärde:None
Stöder jokertecken:True
DontShow:False

Parameteruppsättningar

Path
Position:0
Obligatorisk:True
Värde från pipeline:True
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-WhatIf

Kör kommandot i ett läge som bara rapporterar vad som skulle hända utan att utföra åtgärderna.

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:False
Stöder jokertecken:False
DontShow:False
Alias:Wi

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

CommonParameters

Den här cmdleten stöder vanliga parametrar: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction och -WarningVariable. Mer information finns i about_CommonParameters.

Indata

String

Utdata

Microsoft.PowerShell.PlatyPS.Model.CommandHelp

Kommentarer

Det här kommandot liknar cmdleten Update-MarkdownCommandHelp, men uppdaterar CommandHelp- objekt i minnet i stället för att uppdatera markdown-källfilen.