Update-CommandHelp

Moduł:

Microsoft.PowerShell.PlatyPS Module

Aktualizuje zaimportowany obiekt CommandHelp z informacjami z polecenia cmdlet sesji o tej samej nazwie.

Składnia

Path (Domyślna)

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

LiteralPath

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

Opis

To polecenie cmdlet importuje obiekt CommandHelp z pliku Markdown i aktualizuje obiekt przy użyciu informacji z polecenia cmdlet sesji o tej samej nazwie. Zaktualizowany obiekt można następnie ponownie wyeksportować, aby zaktualizować źródłowy plik Markdown.

Przykłady

Przykład 1

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

19

Parametry

-Confirm

Prosi o potwierdzenie przed uruchomieniem cmdletu.

Właściwości parametru

Typ:	SwitchParameter
Domyślna wartość:	False
Obsługuje symbole wieloznaczne:	False
DontShow:	False
Aliasy:	por

Zestawy parametrów

(All)

Position:	Named
Obowiązkowy:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

-LiteralPath

Określa ścieżkę do co najmniej jednego pliku polecenia markdown. Wartość LiteralPath jest używana dokładnie tak, jak jest typowana. Żadne znaki nie są interpretowane jako symbole wieloznaczne. Jeśli ścieżka zawiera znaki ucieczki, należy ująć ją w pojedynczy cudzysłów. Pojedyncze cudzysłowy wskazują programowi PowerShell, aby nie interpretował żadnych znaków jako sekwencji ucieczki.

Aby uzyskać więcej informacji, zobacz about_Quoting_Rules.

Właściwości parametru

Typ:	String[]
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False
Aliasy:	PSPath, LP

Zestawy parametrów

LiteralPath

Position:	Named
Obowiązkowy:	True
Wartość z potoku:	True
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

-Path

Określa ścieżkę do co najmniej jednego pliku polecenia języka Markdown. Symbole wieloznaczne są dozwolone.

Właściwości parametru

Typ:	String[]
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	True
DontShow:	False

Zestawy parametrów

Path

Position:	0
Obowiązkowy:	True
Wartość z potoku:	True
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

-WhatIf

Uruchamia polecenie w trybie, który zgłasza tylko to, co się stanie, bez wykonywania akcji.

Właściwości parametru

Typ:	SwitchParameter
Domyślna wartość:	False
Obsługuje symbole wieloznaczne:	False
DontShow:	False
Aliasy:	Wi

Zestawy parametrów

(All)

Position:	Named
Obowiązkowy:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

CommonParameters

To polecenie cmdlet obsługuje typowe parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction i -WarningVariable. Aby uzyskać więcej informacji, zobacz about_CommonParameters.

Dane wejściowe

String

Dane wyjściowe

Microsoft.PowerShell.PlatyPS.Model.CommandHelp

Uwagi

To polecenie jest podobne do polecenia cmdlet Update-MarkdownCommandHelp, ale aktualizuje obiekt CommandHelp w pamięci zamiast aktualizować źródłowy plik Markdown.

Linki powiązane

• Update-MarkdownCommandHelp