Partager via

New-CommandHelp

Module:
Microsoft.PowerShell.PlatyPS Module

Crée objets CommandHelp pour une commande PowerShell chargée dans la session.

Syntaxe

__AllParameterSets 

New-CommandHelp
    [-CommandInfo] <CommandInfo[]>
    [<CommonParameters>]

Description

Cette applet de commande prend la liste d’une ou plusieurs commandes PowerShell et crée Objets CommandHelp pour chaque commande. L’objet CommandHelp est une représentation structurée du contenu d’aide qui peut être utilisé pour exporter vers différents formats.

Exemples

Exemple 1 : crée un objet **CommandHelp** pour une applet de commande

L’exemple suivant crée un objet CommandHelp pour l’applet de commande New-PSSession. L’applet de commande Get-Member est utilisée pour afficher les propriétés et méthodes de l’objet CommandHelp.

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;}

Paramètres

-CommandInfo

Liste d’une ou de plusieurs commandes PowerShell (applets de commande, fonctions, scripts). L’applet de commande crée un objet CommandHelp pour chaque commande.

Propriétés du paramètre

Type:

CommandInfo[]

Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:0
Obligatoire:True
Valeur du pipeline:True
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

CommonParameters

Cette applet de commande prend en charge les paramètres courants : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction et -WarningVariable. Pour plus d’informations, consultez about_CommonParameters.

Entrées

CommandInfo

Sorties

Microsoft.PowerShell.PlatyPS.Model.CommandHelp