Update-CommandHelp
インポートされた CommandHelp オブジェクトを、同じ名前のセッション コマンドレットからの情報で更新します。
構文
Path (既定)
Update-CommandHelp
[-Path] <string[]>
[-WhatIf]
[-Confirm]
[<CommonParameters>]
LiteralPath
Update-CommandHelp
-LiteralPath <string[]>
[-WhatIf]
[-Confirm]
[<CommonParameters>]
説明
このコマンドレットは、Markdown ファイルから CommandHelp オブジェクトをインポートし、同じ名前のセッション コマンドレットの情報でオブジェクトを更新します。 更新されたオブジェクトを再エクスポートして、ソース Markdown ファイルを更新できます。
例
例 1
$mdfiles = Measure-PlatyPSMarkdown -Path .\v1\Microsoft.PowerShell.PlatyPS\*.md
$cmdobj = $mdfiles | Where-Object Filetype -match 'CommandHelp' |
Update-CommandHelp -Path {$_.FilePath}
$cmdobj.count
19
パラメーター
-Confirm
コマンドレットを実行する前に確認を求めるメッセージが表示されます。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | False |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | cf |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-LiteralPath
1 つ以上の markdown コマンド ファイルへのパスを指定します。 LiteralPath の値は、入力されたとおりにそのまま使用されます。 ワイルドカードとして解釈される文字はありません。 パスにエスケープ文字が含まれている場合は、単一引用符で囲みます。 単一引用符は、エスケープ シーケンスとして文字を解釈しないように PowerShell に指示します。
詳細については、about_Quoting_Rulesを参照してください。
パラメーターのプロパティ
| 型: | String[] |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | PSPath, LP |
パラメーター セット
LiteralPath
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Path
1 つ以上の Markdown コマンド ファイルへのパスを指定します。 ワイルドカード文字を使用できます。
パラメーターのプロパティ
| 型: | String[] |
| 規定値: | None |
| ワイルドカードのサポート: | True |
| DontShow: | False |
パラメーター セット
Path
| 配置: | 0 |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-WhatIf
アクションを実行せずに何が起こるかのみを報告するモードでコマンドを実行します。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | False |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | ウィスコンシン |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。
入力
String
出力
Microsoft.PowerShell.PlatyPS.Model.CommandHelp
メモ
このコマンドは Update-MarkdownCommandHelp コマンドレットに似ていますが、ソース Markdown ファイルを更新するのではなく、メモリ内の CommandHelp オブジェクトを更新します。