Advanced Windows PowerShell Scripting Video Training

Advanced Windows PowerShell Scripting Video Training
Advanced Windows PowerShell Scripting Video Training

Wednesday, October 27, 2010

In a get-help –full, what does the Position parameter mean?

In PowerShell, you can get a wealth of information from using the Get-Help parameter. For example, if you type Get-Help Get-Command, you receive basic help information for the cmdlet Get-Command. For detailed information, type Get-Help Get-Command –full.

The first section of this expanded help file is the basic information for the cmdlet. It includes the syntax, a description, and in some cases, related commands. The next section list the parameters and the third examples. We will focus on the parameters section.

Below is the parameter Name from Get-Command.

-Name

Gets information only about the cmdlets or command elements with the specified name. represents all or part of the name of the cmdlet or command element. Wildcards are permitted.

To list commands with the same name in execution order, type the command name without wildcard characters. For more information, see the Notes section.

Required? false

Position? 1

Default value

Accept pipeline input? true (ByValue, ByPropertyName)

Accept wildcard characters? false

The Position value tells you if there is a specific order in which this parameter needs to be listed. In this case, it should be the first parameter for this cmdlet. Others that say Named can be placed anywhere after any required parameters.

http://wiki.poshcode.org/Cmdlet_Help/Microsoft.PowerShell.Core/Get-Help

No comments: