Update-CommandHelp

Modul:

Microsoft.PowerShell.PlatyPS Module

Aktualisiert ein importiertes CommandHelp--Objekt mit den Informationen aus dem Sitzungs-Cmdlet mit demselben Namen.

Syntax

Path (Standardwert)

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

LiteralPath

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

Beschreibung

Dieses Cmdlet importiert ein CommandHelp--Objekt aus einer Markdown-Datei und aktualisiert das Objekt mit den Informationen aus dem Sitzungs-Cmdlet mit demselben Namen. Das aktualisierte Objekt kann dann erneut exportiert werden, um die Markdown-Quelldatei zu aktualisieren.

Beispiele

Beispiel 1

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

19

Parameter

-Confirm

Fordert Sie zur Bestätigung auf, bevor Sie das Cmdlet ausführen.

Parametereigenschaften

Typ:	SwitchParameter
Standardwert:	False
Unterstützt Platzhalter:	False
Nicht anzeigen:	False
Aliase:	vgl

Parametersätze

(All)

Position:	Named
Obligatorisch.:	False
Wert aus Pipeline:	False
Wert aus Pipeline nach dem Eigenschaftsnamen:	False
Wert aus verbleibenden Argumenten:	False

-LiteralPath

Gibt einen Pfad zu einer oder mehreren Markdown-Befehlsdateien an. Der Wert LiteralPath- wird genau so verwendet, wie er eingegeben wird. Es werden keine Zeichen als Wildcards interpretiert. Wenn der Pfad Escapezeichen enthält, müssen Sie ihn in einfache Anführungszeichen einschließen. Einfache Anführungszeichen signalisieren PowerShell, dass keine Zeichen als Escapesequenzen interpretiert werden sollen.

Weitere Informationen finden Sie unter über_Zitierregeln.

Parametereigenschaften

Typ:	String[]
Standardwert:	None
Unterstützt Platzhalter:	False
Nicht anzeigen:	False
Aliase:	PSPath, EP

Parametersätze

LiteralPath

Position:	Named
Obligatorisch.:	True
Wert aus Pipeline:	True
Wert aus Pipeline nach dem Eigenschaftsnamen:	False
Wert aus verbleibenden Argumenten:	False

-Path

Gibt den Pfad zu einer oder mehreren Markdown-Befehlsdatei an. Platzhalterzeichen sind zulässig.

Parametereigenschaften

Typ:	String[]
Standardwert:	None
Unterstützt Platzhalter:	True
Nicht anzeigen:	False

Parametersätze

Path

Position:	0
Obligatorisch.:	True
Wert aus Pipeline:	True
Wert aus Pipeline nach dem Eigenschaftsnamen:	False
Wert aus verbleibenden Argumenten:	False

-WhatIf

Führt den Befehl in einem Modus aus, der nur meldet, was passieren würde, ohne die Aktionen auszuführen.

Parametereigenschaften

Typ:	SwitchParameter
Standardwert:	False
Unterstützt Platzhalter:	False
Nicht anzeigen:	False
Aliase:	Wi

Parametersätze

(All)

Position:	Named
Obligatorisch.:	False
Wert aus Pipeline:	False
Wert aus Pipeline nach dem Eigenschaftsnamen:	False
Wert aus verbleibenden Argumenten:	False

CommonParameters

Dieses Cmdlet unterstützt die allgemeinen Parameter -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction und -WarningVariable. Weitere Informationen findest du unter about_CommonParameters.

Eingaben

String

Ausgaben

Microsoft.PowerShell.PlatyPS.Model.CommandHelp

Hinweise

Dieser Befehl ähnelt dem cmdlet Update-MarkdownCommandHelp, aktualisiert jedoch das CommandHelp-Objekt im Arbeitsspeicher, anstatt die Markdown-Quelldatei zu aktualisieren.

Ähnliche Themen

• Update-MarkdownCommandHelp