Partilhar via

New-CommandHelp

Módulo:
Microsoft.PowerShell.PlatyPS Module

Cria objetos CommandHelp para um comando do PowerShell carregado na sessão.

Sintaxe

__AllParameterSets 

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

Descrição

Este cmdlet usa uma lista de um ou mais comandos do PowerShell e cria objetos CommandHelp para cada comando. O objeto CommandHelp é uma representação estruturada do conteúdo da ajuda que pode ser usado para exportar para diferentes formatos.

Exemplos

Exemplo 1 - Cria um objeto **CommandHelp** para um cmdlet

O exemplo a seguir cria um objeto CommandHelp para o cmdlet New-PSSession. O cmdlet é usado para exibir as propriedades e os métodos do objeto 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;}

Parâmetros

-CommandInfo

Uma lista de um ou mais comandos do PowerShell (cmdlets, funções, scripts). O cmdlet cria um objeto CommandHelp para cada comando.

Propriedades dos parâmetros

Tipo:

CommandInfo[]

Valor padrão:None
Suporta curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Posição:0
Obrigatório:True
Valor do pipeline:True
Valor do pipeline por nome da propriedade:False
Valor dos argumentos restantes:False

CommonParameters

Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.

Entradas

CommandInfo

Saídas

Microsoft.PowerShell.PlatyPS.Model.CommandHelp