PowerTip: Find Parameter-Specific Help Information


Summary:  In Windows PowerShell 3.0, see how to find detailed Help information for a specific Windows PowerShell parameter.

Hey, Scripting Guy! Question How do I find detailed Help information for a specific parameter of a Windows PowerShell cmdlet?

Hey, Scripting Guy! Answer Use the –Parameter parameter and specify the parameter name. An example of this is shown here.

17:11 C:\> help New-Partition -Parameter size

 -Size <UInt64>

    Specifies the size of the partition to create.  If not specified, then the units

    will default to bytes. The acceptable value for this parameter is a positive

    number followed by the one of the following unit values: Bytes, KB, MB, GB, or

    TB.

     Required?                    false

    Position?                    named

    Default value

    Accept pipeline input?       false

    Accept wildcard characters?  false

 

 

Comments (6)

  1. JV says:

    New-Partition -par si*

  2. JV says:

    Try

    help New-Partition -par si*

    wildcards are useful if you cannot remember the exact parameter.

  3. Ed Wilson says:

    @JV yes you are correct. Wild Cards are great for both when you do not know the parameter or when you want to shorten your command.

  4. Walid Toumi says:

    thanks for sharing,

    you can create a function to detect if parameter support wildcards:

    ——————8<—————-

    PS II> cat function:Use-WildCards

    function Use-WildCards($command) {

        get-help $command |

             select -expand parameters |

                  foreach {  $_.parameter } |

                      select Name,

                     @{n='SupportWildCards';e={if($_.globbing -eq $true) {$true} else {$false}}}

    }

    PS II> Use-WildCards -command get-process

    name            SupportWildCards

    —-            —————-

    ComputerName               False

    FileVersionInfo            False

    Id                         False

    InputObject                False

    Module                     False

    Name                        True

    ——————8<——————

  5. Ed Wilson says:

    @Walid Toumi that is a really cool idea, and would be something nice to add to one's profile.

  6. Walid Toumi says:

    @Ed Wilson

    i found a bug with a help subsystem:

    ————————–8<—————————

    PS II> Use-WildCards -command Get-Command

    name                                                                                                   SupportWildCards

    —-                                                                                                   —————-

    ArgumentList                                                                                                      False

    CommandType                                                                                                       False

    Module                                                                                                            False

    Name                                                                                                              False

    Noun                                                                                                              False

    Syntax                                                                                                            False

    TotalCount                                                                                                        False

    Verb                                                                                                              False

    PS II> Get-Command -Name hel*

    CommandType     Name                                                Definition

    ———–     —-                                                ———-

    Function        help                                                …

    Application     help.exe                                            D:WINDOWSsystem32help.exe

    ————————–8<—————————

    parameter NAME must supprot wildcard but it return FALSE !

    sorry for my english