New-CommandHelp
Hiermee maakt u CommandHelp objecten voor een PowerShell-opdracht die in de sessie wordt geladen.
Syntaxis
__AllParameterSets
New-CommandHelp
[-CommandInfo] <CommandInfo[]>
[<CommonParameters>]
Description
Deze cmdlet gebruikt een lijst met een of meer PowerShell-opdrachten en maakt CommandHelp objecten voor elke opdracht. Het CommandHelp-object is een gestructureerde weergave van de Help-inhoud die kan worden gebruikt voor het exporteren naar verschillende indelingen.
Voorbeelden
Voorbeeld 1: hiermee maakt u een **CommandHelp**-object voor een cmdlet
In het volgende voorbeeld wordt een CommandHelp--object gemaakt voor de cmdlet New-PSSession. De cmdlet Get-Member wordt gebruikt om de eigenschappen en methoden van het CommandHelp--object weer te geven.
New-CommandHelp New-PSSession | Get-Member
TypeName: Microsoft.PowerShell.PlatyPS.Model.CommandHelp
Name MemberType Definition
---- ---------- ----------
Equals Method bool Equals(Microsoft.PowerShell.PlatyPS.Model.CommandHelp other)...
GetHashCode Method int GetHashCode()
GetType Method type GetType()
ToString Method string ToString()
TryGetParameter Method bool TryGetParameter(string name, [ref] Microsoft.PowerShell.Plat...
Aliases Property System.Collections.Generic.List[string] Aliases {get;}
Description Property string Description {get;set;}
Diagnostics Property Microsoft.PowerShell.PlatyPS.Model.Diagnostics Diagnostics {get;s...
Examples Property System.Collections.Generic.List[Microsoft.PowerShell.PlatyPS.Mode...
ExternalHelpFile Property string ExternalHelpFile {get;set;}
HasCmdletBinding Property bool HasCmdletBinding {get;set;}
HasWorkflowCommonParameters Property bool HasWorkflowCommonParameters {get;set;}
Inputs Property System.Collections.Generic.List[Microsoft.PowerShell.PlatyPS.Mode...
Locale Property cultureinfo Locale {get;set;}
Metadata Property ordered Metadata {get;set;}
ModuleGuid Property System.Nullable[guid] ModuleGuid {get;set;}
ModuleName Property string ModuleName {get;set;}
Notes Property string Notes {get;set;}
OnlineVersionUrl Property string OnlineVersionUrl {get;set;}
Outputs Property System.Collections.Generic.List[Microsoft.PowerShell.PlatyPS.Mode...
Parameters Property System.Collections.Generic.List[Microsoft.PowerShell.PlatyPS.Mode...
RelatedLinks Property System.Collections.Generic.List[Microsoft.PowerShell.PlatyPS.Mode...
SchemaVersion Property string SchemaVersion {get;set;}
Synopsis Property string Synopsis {get;set;}
Syntax Property System.Collections.Generic.List[Microsoft.PowerShell.PlatyPS.Mode...
Title Property string Title {get;set;}
Parameters
-CommandInfo
Een lijst met een of meer PowerShell-opdrachten (cmdlets, functies, scripts). De cmdlet maakt voor elke opdracht een CommandHelp--object.
Parametereigenschappen
| Type: | |
| Default value: | None |
| Ondersteunt jokertekens: | False |
| DontShow: | False |
Parametersets
(All)
| Position: | 0 |
| Verplicht: | True |
| Waarde uit pijplijn: | True |
| 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.