Modules/Utility/Pscx.Utility.psm1
|
Set-StrictMode -Version Latest Set-Alias e Pscx\Edit-File -Description "PSCX alias" Set-Alias ehp Pscx\Edit-HostProfile -Description "PSCX alias" Set-Alias ep Pscx\Edit-Profile -Description "PSCX alias" Set-Alias gpar Pscx\Get-Parameter -Description "PSCX alias" Set-Alias su Pscx\Invoke-Elevated -Description "PSCX alias" Set-Alias igc Pscx\Invoke-GC -Description "PSCX alias" Set-Alias call Pscx\Invoke-Method -Description "PSCX alias" Set-Alias nho Pscx\New-HashObject -Description "PSCX alias" Set-Alias ql Pscx\QuoteList -Description "PSCX alias" Set-Alias qs Pscx\QuoteString -Description "PSCX alias" Set-Alias rver Pscx\Resolve-ErrorRecord -Description "PSCX alias" Set-Alias rvhr Pscx\Resolve-HResult -Description "PSCX alias" Set-Alias rvwer Pscx\Resolve-WindowsError -Description "PSCX alias" Set-Alias sro Pscx\Set-ReadOnly -Description "PSCX alias" Set-Alias swr Pscx\Set-Writable -Description "PSCX alias" # Initialize the PSCX RegexLib object. & { $RegexLib = new-object psobject function AddRegex($name, $regex) { Add-Member -Input $RegexLib NoteProperty $name $regex } AddRegex CDQString '(?<CDQString>"\\.|[^\\"]*")' AddRegex CSQString "(?<CSQString>'\\.|[^'\\]*')" AddRegex CMultilineComment '(?<CMultilineComment>/\*[^*]*\*+(?:[^/*][^*]*\*+)*/)' AddRegex CppEndOfLineComment '(?<CppEndOfLineComment>//[^\n]*)' AddRegex CComment "(?:$($RegexLib.CDQString)|$($RegexLib.CSQString))|(?<CComment>$($RegexLib.CMultilineComment)|$($RegexLib.CppEndOfLineComment))" AddRegex PSComment '(?<PSComment>#[^\n]*)' AddRegex PSNonCommentedLine '(?<PSNonCommentedLine>^(?>\s*)(?!#|$))' AddRegex EmailAddress '(?<EmailAddress>[A-Z0-9._%-]+@(?:[A-Z0-9-]+\.)+[A-Z]{2,4})' AddRegex IPv4 '(?<IPv4>)(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))' AddRegex RepeatedWord '\b(?<RepeatedWord>(\w+)\s+\1)\b' AddRegex HexDigit '[0-9a-fA-F]' AddRegex HexNumber '(?<HexNumber>(0[xX])?[0-9a-fA-F]+)' AddRegex DecimalNumber '(?<DecimalNumber>[+-]?(?:\d+\.?\d*|\d*\.?\d+))' AddRegex ScientificNotation '(?<ScientificNotation>[+-]?(?<Significand>\d+\.?\d*|\d*\.?\d+)[\x20]?(?<Exponent>[eE][+\-]?\d+)?)' $Pscx:RegexLib = $RegexLib } $acceleratorsType = [psobject].Assembly.GetType('System.Management.Automation.TypeAccelerators') # If these accelerators have already been defined, don't override (and don't error) function AddAccelerator($name, $type) { if (!$acceleratorsType::Get.ContainsKey($name)) { $acceleratorsType::Add($name, $type) } } AddAccelerator "accelerators" $acceleratorsType AddAccelerator "hex" ([Pscx.TypeAccelerators.Hex]) <# .SYNOPSIS Creates the registry entries required to create Windows Explorer context menu "Open PowerShell Here" for both Directories and Drives .NOTES Author: Keith Hill #> function Enable-OpenPowerShellHere { function New-OpenPowerShellContextMenuEntry { param($Path) New-Item $Path -ItemType RegistryKey -Force New-ItemProperty $Path -Name '(Default)' -Value 'Open PowerShell Here' New-Item $Path\Command -ItemType RegistryKey New-ItemProperty $Path\Command -Name '(Default)' ` -Value "`"$pshome\powershell.exe`" -NoExit -Command [Environment]::CurrentDirectory=(Set-Location -LiteralPath:'%L' -PassThru).ProviderPath" } New-OpenPowerShellContextMenuEntry 'HKCU:\Software\Classes\Directory\shell\PowerShell' New-OpenPowerShellContextMenuEntry 'HKCU:\Software\Classes\Drive\shell\PowerShell' } <# .SYNOPSIS Create a PSObject from a dictionary such as a hashtable. .DESCRIPTION Create a PSObject from a dictionary such as a hashtable. The keys-value pairs are turned into NoteProperties. .PARAMETER InputObject Any object from which to get the specified property .EXAMPLE C:\PS> $ht = @{fname='John';lname='Doe';age=42}; $ht | New-HashObject Creates a hashtable in $ht and then converts that into a PSObject. .NOTES Aliases: nho #> filter New-HashObject { if ($_ -isnot [Collections.IDictionary]) { return $_ } $result = new-object PSObject $hash = $_ $hash.Keys | %{ $result | add-member NoteProperty "$_" $hash[$_] -force } $result } <# .SYNOPSIS Similar to the C# ? : operator e.g. name = (value != null) ? String.Empty : value .DESCRIPTION Similar to the C# ? : operator e.g. name = (value != null) ? String.Empty : value. The first script block is tested. If it evaluates to $true then the second scripblock is evaluated and its results are returned otherwise the third scriptblock is evaluated and its results are returned. .PARAMETER Condition The condition that determines whether the TrueBlock scriptblock is used or the FalseBlock is used. .PARAMETER TrueBlock This block gets evaluated and its contents are returned from the function if the Conditon scriptblock evaluates to $true. .PARAMETER FalseBlock This block gets evaluated and its contents are returned from the function if the Conditon scriptblock evaluates to $false. .PARAMETER InputObject Specifies the input object. Invoke-Ternary injects the InputObject into each scriptblock provided via the Condition, TrueBlock and FalseBlock parameters. .EXAMPLE C:\PS> $toolPath = ?: {[IntPtr]::Size -eq 4} {"$env:ProgramFiles(x86)\Tools"} {"$env:ProgramFiles\Tools"}} Each input number is evaluated to see if it is > 5. If it is then "Greater than 5" is displayed otherwise "Less than or equal to 5" is displayed. .EXAMPLE C:\PS> 1..10 | ?: {$_ -gt 5} {"Greater than 5";$_} {"Less than or equal to 5";$_} Each input number is evaluated to see if it is > 5. If it is then "Greater than 5" is displayed otherwise "Less than or equal to 5" is displayed. .NOTES Aliases: ?: Author: Karl Prosser #> function Invoke-Ternary { param( [Parameter(Mandatory, Position=0)] [scriptblock] $Condition, [Parameter(Mandatory, Position=1)] [scriptblock] $TrueBlock, [Parameter(Mandatory, Position=2)] [scriptblock] $FalseBlock, [Parameter(ValueFromPipeline, ParameterSetName='InputObject')] [psobject] $InputObject ) Process { if ($pscmdlet.ParameterSetName -eq 'InputObject') { Foreach-Object $Condition -input $InputObject | Foreach { if ($_) { Foreach-Object $TrueBlock -InputObject $InputObject } else { Foreach-Object $FalseBlock -InputObject $InputObject } } } elseif (&$Condition) { &$TrueBlock } else { &$FalseBlock } } } <# .SYNOPSIS Similar to the C# ?? operator e.g. name = value ?? String.Empty .DESCRIPTION Similar to the C# ?? operator e.g. name = value ?? String.Empty; where value would be a Nullable<T> in C#. Even though PowerShell doesn't support nullables yet we can approximate this behavior. In the example below, $LogDir will be assigned the value of $env:LogDir if it exists and it's not null, otherwise it get's assigned the result of the second script block (C:\Windows\System32\LogFiles). This behavior is also analogous to Korn shell assignments of this form: LogDir = ${$LogDir:-$WinDir/System32/LogFiles} .PARAMETER PrimaryExpr The condition that determines whether the TrueBlock scriptblock is used or the FalseBlock is used. .PARAMETER AlternateExpr This block gets evaluated and its contents are returned from the function if the Conditon scriptblock evaluates to $true. .PARAMETER InputObject Specifies the input object. Invoke-NullCoalescing injects the InputObject into each scriptblock provided via the PrimaryExpr and AlternateExpr parameters. .EXAMPLE C:\PS> $LogDir = ?? {$env:LogDir} {"$env:windir\System32\LogFiles"} $LogDir is set to the value of $env:LogDir unless it doesn't exist, in which case it will then default to "$env:windir\System32\LogFiles". .NOTES Aliases: ?? Author: Keith Hill #> function Invoke-NullCoalescing { param( [Parameter(Mandatory, Position=0)] [AllowNull()] [scriptblock] $PrimaryExpr, [Parameter(Mandatory, Position=1)] [scriptblock] $AlternateExpr, [Parameter(ValueFromPipeline, ParameterSetName='InputObject')] [psobject] $InputObject ) Process { if ($pscmdlet.ParameterSetName -eq 'InputObject') { if ($PrimaryExpr -eq $null) { Foreach-Object $AlternateExpr -InputObject $InputObject } else { $result = Foreach-Object $PrimaryExpr -input $InputObject if ($result -eq $null) { Foreach-Object $AlternateExpr -InputObject $InputObject } else { $result } } } else { if ($PrimaryExpr -eq $null) { &$AlternateExpr } else { $result = &$PrimaryExpr if ($result -eq $null) { &$AlternateExpr } else { $result } } } } } <# .FORWARDHELPTARGETNAME Get-Help .FORWARDHELPCATEGORY Cmdlet #> function PscxHelp { [CmdletBinding(DefaultParameterSetName='AllUsersView', HelpUri='https://go.microsoft.com/fwlink/?LinkID=113316')] param( [Parameter(Position=0, ValueFromPipelineByPropertyName=$true)] [string] ${Name}, [string] ${Path}, [ValidateSet('Alias','Cmdlet','Provider','General','FAQ','Glossary','HelpFile','ScriptCommand','Function','Filter','ExternalScript','All','DefaultHelp','DscResource','Class','Configuration')] [string[]] ${Category}, [Parameter(ParameterSetName='DetailedView', Mandatory=$true)] [switch] ${Detailed}, [Parameter(ParameterSetName='AllUsersView')] [switch] ${Full}, [Parameter(ParameterSetName='Examples', Mandatory=$true)] [switch] ${Examples}, [Parameter(ParameterSetName='Parameters', Mandatory=$true)] [string[]] ${Parameter}, [string[]] ${Component}, [string[]] ${Functionality}, [string[]] ${Role}, [Parameter(ParameterSetName='Online', Mandatory=$true)] [switch] ${Online}, [Parameter(ParameterSetName='ShowWindow', Mandatory=$true)] [switch] ${ShowWindow} ) # Display the full help topic by default but only for the AllUsersView parameter set. if (($psCmdlet.ParameterSetName -eq 'AllUsersView') -and !$Full) { $PSBoundParameters['Full'] = $true } # Nano needs to use Unicode, but Windows and Linux need the default $OutputEncoding = [System.Console]::OutputEncoding $help = Get-Help @PSBoundParameters # If a list of help is returned or AliasHelpInfo (because it is small), don't pipe to more $psTypeNames = ($help | Select-Object -First 1).PSTypeNames if ($psTypeNames -Contains 'HelpInfoShort' -Or $psTypeNames -Contains 'AliasHelpInfo') { $help } elseif ($help -ne $null) { # By default use more on Windows and less on Linux. if ($Pscx:Preferences["PageHelpUsingLess"]) { $pagerCommand = "$Pscx:Home\Apps\less.exe" $pagerArgs = '-Ps"Page %db?B of %D:.\. Press h for help or q to quit\.$"' } else { $pagerCommand = 'more.com' $pagerArgs = $null } # Respect PAGER environment variable which allows user to specify a custom pager. # Ignore a pure whitespace PAGER value as that would cause the tokenizer to return 0 tokens. if (![string]::IsNullOrWhitespace($env:PAGER)) { if (Get-Command $env:PAGER -ErrorAction Ignore) { # Entire PAGER value corresponds to a single command. $pagerCommand = $env:PAGER $pagerArgs = $null } else { # PAGER value is not a valid command, check if PAGER command and arguments have been specified. # Tokenize the specified $env:PAGER value. Ignore tokenizing errors since any errors may be valid # argument syntax for the paging utility. $errs = $null $tokens = [System.Management.Automation.PSParser]::Tokenize($env:PAGER, [ref]$errs) $customPagerCommand = $tokens[0].Content if (!(Get-Command $customPagerCommand -ErrorAction Ignore)) { # Custom pager command is invalid, issue a warning. Write-Warning "Custom-paging utility command not found. Ignoring command specified in `$env:PAGER: $env:PAGER" } else { # This approach will preserve all the pagers args. $pagerCommand = $customPagerCommand $pagerArgs = if ($tokens.Count -gt 1) {$env:PAGER.Substring($tokens[1].Start)} else {$null} } } } $pagerCommandInfo = Get-Command -Name $pagerCommand -ErrorAction Ignore if ($pagerCommandInfo -eq $null) { $help } elseif ($pagerCommandInfo.CommandType -eq 'Application') { # If the pager is an application, format the output width before sending to the app. $consoleWidth = [System.Math]::Max([System.Console]::WindowWidth, 20) if ($pagerArgs) { # Supply pager arguments to an application without any PowerShell parsing of the arguments. # Leave environment variable to help user debug arguments supplied in $env:PAGER. $env:__PSPAGER_ARGS = $pagerArgs $help | Out-String -Stream -Width ($consoleWidth - 1) | & $pagerCommand --% %__PSPAGER_ARGS% } else { $help | Out-String -Stream -Width ($consoleWidth - 1) | & $pagerCommand } } else { # The pager command is a PowerShell function, script or alias, so pipe directly into it. $help | & $pagerCommand $pagerArgs } } } <# .SYNOPSIS PscxLess provides better paging of output from cmdlets. .DESCRIPTION PscxLess provides better paging of output from cmdlets. By default PowerShell uses more.com for paging which is a pretty minimal paging app that doesn't support advanced navigation features. This function uses Less.exe ie Less394 as the replacement for more.com. Less can navigate down as well as up and can be scrolled by page or by line and responds to the Home and End keys. Less also supports searching the text by pressing the "/" key followed by the term to search for then the "Enter" key. One of the primary keyboard shortcuts to know with less.exe is the key to exit. Pressing the "q" key will exit less.exe. For more help on less.exe press the "h" key. If you prefer to use more.com set the PSCX preference variable PageHelpUsingLess to $false e.g. $Pscx:Preferences['PageHelpUsingLess'] = $false .PARAMETER LiteralPath Specifies the path to a file to view. Unlike Path, the value of LiteralPath is used exactly as it is typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell Windows PowerShell not to interpret any characters as escape sequences. .PARAMETER Path The path to the file to view. Wildcards are accepted. .EXAMPLE C:\PS> man about_profiles -full This sends the help output of the about_profiles topic to the help function which pages the output. Man is an alias for the "help" function. PSCX overrides the help function to page help using either the built-in PowerShell "more" function or the PSCX "less" function depending on the value of the PageHelpUsingLess preference variable. .EXAMPLE C:\PS> PscxLess *.txt Opens each text file in less.exe in succession. Pressing ':n' moves to the next file. .NOTES This function is just a passthru in all other hosts except for the PowerShell.exe console host. .LINK http://en.wikipedia.org/wiki/Less_(Unix) #> function PscxLess { param([string[]]$Path, [string[]]$LiteralPath) if ($host.Name -ne 'ConsoleHost') { # The rest of this function only works well in PowerShell.exe $input return } $OutputEncoding = [System.Console]::OutputEncoding $resolvedPaths = $null if ($LiteralPath) { $resolvedPaths = $LiteralPath } elseif ($Path) { $resolvedPaths = @() # In the non-literal case we may need to resolve a wildcarded path foreach ($apath in $Path) { if (Test-Path $apath) { $resolvedPaths += @(Resolve-Path $apath | Foreach { $_.Path }) } else { $resolvedPaths += $apath } } } $lessPrompt = '-PsPage %db?B of %D:.\. Press h for help or q to quit\.$' # Tricky to get this just right. # Here are three test cases to verify all works as it should: # less *.txt : Should bring up named txt file in less in succession, press q to go to next file # man gcm -full : Should open help topic in less, press q to quit # man gcm -online : Should open help topic in web browser but not open less.exe if ($resolvedPaths) { & "$Pscx:Home\Apps\less.exe" $resolvedPaths $lessPrompt } elseif ($input.MoveNext()) { $input.Reset() $input | & "$Pscx:Home\Apps\less.exe" $lessPrompt } } <# .SYNOPSIS Opens the current user's "all hosts" profile in a text editor. .DESCRIPTION Opens the current user's "all hosts" profile ($Profile.CurrentUserAllHosts) in a text editor. .EXAMPLE C:\PS> Edit-Profile Opens the current user's "all hosts" profile in a text editor. .NOTES Aliases: ep Author: Keith Hill #> function Edit-Profile { Edit-File $Profile.CurrentUserAllHosts } <# .SYNOPSIS Opens the current user's profile for the current host in a text editor. .DESCRIPTION Opens the current user's profile for the current host ($Profile.CurrentUserCurrentHost) in a text editor. .EXAMPLE C:\PS> Edit-HostProfile Opens the current user's profile for the current host in a text editor. .NOTES Aliases: ehp Author: Keith Hill #> function Edit-HostProfile { Edit-File $Profile.CurrentUserCurrentHost } <# .SYNOPSIS Runs the specified command in an elevated context. .DESCRIPTION Runs the specified command in an elevated context. This is useful on Windows Vista and Windows 7 when you run with a standard user token but can elevate to Admin when needed. .EXAMPLE C:\PS> Invoke-Elevated Opens a new PowerShell instance as admin. .EXAMPLE C:\PS> Invoke-Elevated Notepad C:\windows\system32\drivers\etc\hosts Opens notepad elevated with the hosts file so that you can save changes to the file. .EXAMPLE C:\PS> Invoke-Elevated {gci c:\windows\temp | export-clixml tempdir.xml; exit} Executes the scriptblock in an elevated PowerShell instance. .EXAMPLE C:\PS> Invoke-Elevated {gci c:\windows\temp | export-clixml tempdir.xml; exit} | %{$_.WaitForExit(5000)} | %{Import-Clixml tempdir.xml} Executes the scriptblock in an elevated PowerShell instance, waits for that elevated process to execute, then retrieves the results. .NOTES Aliases: su Author: Keith Hill #> function Invoke-Elevated() { Write-Debug "`$MyInvocation:`n$($MyInvocation | Out-String)" $escapedPath = [System.Management.Automation.Language.CodeGeneration]::EscapeSingleQuotedStringContent($pwd.ProviderPath) $startProcessArgs = @{ FilePath = "PowerShell.exe" ArgumentList = "-NoExit", "-Command", "& {Set-Location '$escapedPath'}" Verb = "runas" PassThru = $true WorkingDir = $pwd } $OFS = " " if ($args.Count -eq 0) { Write-Debug " Starting Powershell without no supplied args" } elseif ($args[0] -is [Scriptblock]) { $script = $args[0] if ($script -match '(?si)\s*param\s*\(') { $startProcessArgs['ArgumentList'] = "-NoExit", "-Command", "& {$script}" } else { $startProcessArgs['ArgumentList'] = "-NoExit", "-Command", "& {Set-Location '$escapedPath'; $script}" } [string[]]$cmdArgs = @() if ($args.Count -gt 1) { $cmdArgs = $args[1..$($args.Length-1)] $startProcessArgs['ArgumentList'] += $cmdArgs } Write-Debug " Starting PowerShell with scriptblock: {$script} and args: $cmdArgs" } else { $app = Get-Command $args[0] | Select -First 1 | Where {$_.CommandType -eq 'Application'} [string[]]$cmdArgs = @() if ($args.Count -gt 1) { $cmdArgs = $args[1..$($args.Length-1)] } if ($app) { $startProcessArgs['FilePath'] = $app.Path if ($cmdArgs.Count -eq 0) { $startProcessArgs.Remove('ArgumentList') } else { $startProcessArgs['ArgumentList'] = $cmdArgs } Write-Debug " Starting app $app with args: $cmdArgs" } else { $poshCmd = $args[0] $startProcessArgs['ArgumentList'] = "-NoExit", "-Command", "& {Set-Location '$escapedPath'; $poshCmd $cmdArgs}" Write-Debug " Starting PowerShell command $poshCmd with args: $cmdArgs" } } Write-Debug " Invoking Start-Process with args: $($startProcessArgs | Format-List | Out-String)" Microsoft.PowerShell.Management\Start-Process @startProcessArgs } <# .SYNOPSIS Resolves the PowerShell error code to a textual description of the error. .DESCRIPTION Use when reporting an error or ask a question about a exception you are seeing. This function provides all the information we have about the error message making it easier to diagnose what is actually going on. .PARAMETER ErrorRecord The ErrorRecord to resolve into a useful error report. The default value is $Error[0] - the last error that occurred. .EXAMPLE C:\PS> Resolve-ErrorRecord Resolves the most recent PowerShell error code to a textual description of the error. .NOTES Aliases: rver #> function Resolve-ErrorRecord { param( [Parameter(Position=0, ValueFromPipeline=$true)] [ValidateNotNull()] [System.Management.Automation.ErrorRecord[]] $ErrorRecord ) Process { if (!$ErrorRecord) { if ($global:Error.Count -eq 0) { Write-Host "The `$Error collection is empty." return } else { $ErrorRecord = @($global:Error[0]) } } foreach ($record in $ErrorRecord) { $txt = @($record | Format-List * -Force | Out-String -Stream) $txt += @($record.InvocationInfo | Format-List * | Out-String -Stream) $Exception = $record.Exception for ($i = 0; $Exception; $i++, ($Exception = $Exception.InnerException)) { $txt += "Exception at nesting level $i ---------------------------------------------------" $txt += @($Exception | Format-List * -Force | Out-String -Stream) } $txt | Foreach {$prevBlank=$false} { if ($_.Trim().Length -gt 0) { $_ $prevBlank = $false } elseif (!$prevBlank) { $_ $prevBlank = $true } } } } } <# .SYNOPSIS Resolves the hresult error code to a textual description of the error. .DESCRIPTION Resolves the hresult error code to a textual description of the error. .PARAMETER HResult The hresult error code to resolve. .EXAMPLE C:\PS> Resolve-HResult -2147023293 Fatal error during installation. (Exception from HRESULT: 0x80070643) .NOTES Aliases: rvhr #> function Resolve-HResult { param( [Parameter(Mandatory=$true, Position=0, ValueFromPipeline=$true)] [long[]] $HResult ) Process { foreach ($hr in $HResult) { $comEx = [System.Runtime.InteropServices.Marshal]::GetExceptionForHR($hr) if ($comEx) { $comEx.Message } else { Write-Error "$hr doesn't correspond to a known HResult" } } } } <# .SYNOPSIS Resolves a Windows error number a textual description of the error. .DESCRIPTION Resolves a Windows error number a textual description of the error. The Windows error number is typically retrieved via the Win32 API GetLastError() but it is typically displayed in messages to the end user. .PARAMETER ErrorNumber The Windows error code number to resolve. .EXAMPLE C:\PS> Resolve-WindowsError 5 Access is denied .NOTES Aliases: rvwer #> function Resolve-WindowsError { param( [Parameter(Mandatory=$true, Position=0, ValueFromPipeline=$true)] [int[]] $ErrorNumber ) Process { foreach ($num in $ErrorNumber) { $win32Ex = new-object ComponentModel.Win32Exception $num if ($win32Ex) { $win32Ex.Message } else { Write-Error "$num does not correspond to a known Windows error code" } } } } <# .SYNOPSIS Convenience function for creating an array of strings without requiring quotes or commas. .DESCRIPTION Convenience function for creating an array of strings without requiring quotes or commas. .EXAMPLE C:\PS> QuoteList foo bar baz This is the equivalent of 'foo', 'bar', 'baz' .EXAMPLE C:\PS> ql foo bar baz This is the equivalent of 'foo', 'bar', 'baz'. Same example as above but using the alias for QuoteList. .NOTES Aliases: ql #> function QuoteList { $args } <# .SYNOPSIS Creates a string from each parameter by concatenating each item using $OFS as the separator. .DESCRIPTION Creates a string from each parameter by concatenating each item using $OFS as the separator. .EXAMPLE C:\PS> QuoteString $a $b $c This is the equivalent of "$a $b $c". .EXAMPLE C:\PS> qs $a $b $c This is the equivalent of "$a $b $c". Same example as above but using the alias for QuoteString. .NOTES Aliases: qs #> function QuoteString { "$args" } <# .SYNOPSIS Invokes the .NET garbage collector to clean up garbage objects. .DESCRIPTION Invokes the .NET garbage collector to clean up garbage objects. Invoking a garbage collection can be useful when .NET objects haven't been disposed and is causing a file system handle to not be released. .EXAMPLE C:\PS> Invoke-GC Invokes a garbage collection to free up resources and memory. #> function Invoke-GC { [System.GC]::Collect() } <# .SYNOPSIS Invokes the specified batch file and retains any environment variable changes it makes. .DESCRIPTION Invoke the specified batch file (and parameters), but also propagate any environment variable changes back to the PowerShell environment that called it. .PARAMETER Path Path to a .bat or .cmd file. .PARAMETER Parameters Parameters to pass to the batch file. .EXAMPLE C:\PS> Invoke-BatchFile "$env:ProgramFiles\Microsoft Visual Studio 9.0\VC\vcvarsall.bat" Invokes the vcvarsall.bat file. All environment variable changes it makes will be propagated to the current PowerShell session. .NOTES Author: Lee Holmes #> function Invoke-BatchFile { param([string]$Path, [string]$Parameters) $tempFile = [IO.Path]::GetTempFileName() ## Store the output of cmd.exe. We also ask cmd.exe to output ## the environment table after the batch file completes cmd.exe /c " `"$Path`" $Parameters && set " > $tempFile ## Go through the environment variables in the temp file. ## For each of them, set the variable in our local environment. Get-Content $tempFile | Foreach-Object { if ($_ -match "^(.*?)=(.*)$") { Set-Content "env:\$($matches[1])" $matches[2] } else { $_ } } Remove-Item $tempFile } <# .SYNOPSIS Gets the possible alternate views for the specified object. .DESCRIPTION Gets the possible alternate views for the specified object. .PARAMETER TypeName Name of the type for which to retrieve the view definitions. .PARAMETER Path Path to a specific format data PS1XML file. Wildcards are accepted. The default value is an empty array which will load the default .ps1xml files and exported format files from modules loaded in the current session .PARAMETER IncludeSnapInFormatting Include the exported format information from v1 PSSnapins. .EXAMPLE C:\PS> Get-ViewDefinition Retrieves all view definitions from the PowerShell format files. .EXAMPLE C:\PS> Get-ViewDefinition System.Diagnostics.Process Retrieves all view definitions for the .NET type System.Diagnostics.Process. .EXAMPLE C:\PS> Get-Process | Get-ViewDefinition | ft Name,Style -groupby SelectedBy Retrieves all view definitions for the .NET type System.Diagnostics.Process. .EXAMPLE C:\PS> Get-ViewDefinition Pscx.Commands.Net.PingHostStatistics $Pscx:Home\Modules\Net\Pscx.Net.Format.ps1xml Retrieves all view definitions for the .NET type Pscx.Commands.Net.PingHostStatistics. .NOTES Author: Joris van Lier and Keith Hill #> function Get-ViewDefinition { [CmdletBinding(DefaultParameterSetName="Name")] param( [Parameter(Position=0, ParameterSetName="Name")] [string] $TypeName, [Parameter(Position=0, ParameterSetName="Object", ValueFromPipeline=$true)] [psobject] $InputObject, [Parameter(Position=1)] [string[]] $Path = @(), [Parameter(Position=2)] [switch] $IncludeSnapInFormatting ) Begin { # Setup arrays to hold Format XMLDocument objects and the paths to them $arrFormatFiles = @() $arrFormatFilePaths = @() # If a specific Path is specified, use that, otherwise load all defaults # which consist of the default formatting files, and exported format files # from modules if ($Path.count -eq 0) { # Populate the arrays with the standard ps1xml format file information gci $PsHome *.format.ps1xml | % ` { if (Test-Path $_.fullname) { $x = New-Object xml.XmlDocument $x.Load($_.fullname) $arrFormatFiles += $x $arrFormatFilePaths += $_.fullname } } # Populate the arrays with format info from loaded modules Get-Module | Select -ExpandProperty exportedformatfiles | % ` { if (Test-Path $_) { $x = New-Object xml.XmlDocument $x.load($_) $arrFormatFiles += $x $arrFormatFilePaths += $_ } } # Processing snapin formatting seems to be slow, and snapins are more or less # deprecated with modules in v2, so exclude them by default if ($IncludeSnapInFormatting) { # Populate the arrays with format info from loaded snapins Get-PSSnapin | ? { $_.name -notmatch "Microsoft\." } | select applicationbase,formats | % ` { foreach ($f in $_.formats) { $x = New-Object xml.xmlDocument if ( test-path $f ) { $x.load($f) $arrFormatFiles += $x $arrFormatFilePaths += $f } else { $fpath = "{0}\{1}" -f $_.ApplicationBase,$f if (Test-Path $fpath) { $x.load($fpath) $arrFormatFiles += $x $arrFormatFilePaths += $fpath } } } } } } else { foreach ($p in $path) { $x = New-Object xml.xmldocument if (Test-Path $p) { $x.load($p) $arrFormatFiles += $x $arrFormatFilePaths += $p } } } $TypesSeen = @{} # The functions below reference object members that may not exist Set-StrictMode -Version 1.0 function IsViewSelectedByTypeName($view, $typeName, $formatFile) { if ($view.ViewSelectedBy.TypeName) { foreach ($t in @($view.ViewSelectedBy.TypeName)) { if ($typeName -eq $t) { return $true } } $false } elseif ($view.ViewSelectedBy.SelectionSetName) { $typeNameNodes = $formatFile.SelectNodes('/Configuration/SelectionSets/SelectionSet/Types') $typeNames = $typeNameNodes | foreach {$_.TypeName} $typeNames -contains $typeName } else { $false } } function GenerateViewDefinition($typeName, $view, $path) { $ViewDefinition = new-object psobject Add-Member NoteProperty Name $view.Name -Input $ViewDefinition Add-Member NoteProperty Path $path -Input $ViewDefinition Add-Member NoteProperty TypeName $typeName -Input $ViewDefinition $selectedBy = "" if ($view.ViewSelectedBy.TypeName) { $selectedBy = $view.ViewSelectedBy.TypeName } elseif ($view.ViewSelectedBy.SelectionSetName) { $selectedBy = $view.ViewSelectedBy.SelectionSetName } Add-Member NoteProperty SelectedBy $selectedBy -Input $ViewDefinition Add-Member NoteProperty GroupBy $view.GroupBy.PropertyName -Input $ViewDefinition if ($view.TableControl) { Add-Member NoteProperty Style 'Table' -Input $ViewDefinition } elseif ($view.ListControl) { Add-Member NoteProperty Style 'List' -Input $ViewDefinition } elseif ($view.WideControl) { Add-Member NoteProperty Style 'Wide' -Input $ViewDefinition } elseif ($view.CustomControl) { Add-Member NoteProperty Style 'Custom' -Input $ViewDefinition } else { Add-Member NoteProperty Style 'Unknown' -Input $ViewDefinition } $ViewDefinition } function GenerateViewDefinitions($typeName, $path) { for ($i = 0 ; $i -lt $arrFormatFiles.count ; $i++) { $formatFile = $arrFormatFiles[$i] $path = $arrFormatFilePaths[$i] foreach ($view in $formatFile.Configuration.ViewDefinitions.View) { if ($typeName) { if (IsViewSelectedByTypeName $view $typeName $formatFile) { GenerateViewDefinition $typeName $view $path } } else { GenerateViewDefinition $typeName $view $path } } } } } Process { if ($pscmdlet.ParameterSetName -eq 'Name') { GenerateViewDefinitions $TypeName #$Path } elseif (!$TypesSeen[$InputObject.PSObject.TypeNames[0]]) { if ($InputObject -is [string]) { GenerateViewDefinitions $InputObject } else { GenerateViewDefinitions $InputObject.PSObject.TypeNames[0] } $TypesSeen[$InputObject.PSObject.TypeNames[0]] = $true } } } <# .SYNOPSIS Outputs text as spoken words. .DESCRIPTION Outputs text as spoken words. .PARAMETER InputObject One or more objects to speak. .PARAMETER Wait Wait for the machine to read each item (NOT asynchronous). .PARAMETER Purge Purge all other speech requests before making this call. .PARAMETER ReadFiles Read the contents of the text files indicated. .PARAMETER ReadXml Treat input as speech XML markup. .PARAMETER NotXml Do NOT parse as XML (if text starts with "<" but is not XML). .EXAMPLE C:\PS> Out-Speech "Hello World" Speaks "hello world". .EXAMPLE C:\PS> Get-Content quotes.txt | Get-Random | Out-Speech -wait Speaks a random quote from a file. .EXAMPLE C:\PS> Out-Speech -readfiles "Hitchhiker's Guide To The Galaxy.txt" Speaks the entire contents of a file. .NOTES Author: Joel "Jaykul" Bennett #> function Out-Speech { param( [Parameter(Position=0, Mandatory=$true, ValueFromPipeline=$true)] [psobject[]] $InputObject, [switch] $Wait, [switch] $Purge, [switch] $ReadFiles, [switch] $ReadXml, [switch] $NotXml ) begin { # To override this default, use the other flag values given below. $SPF_DEFAULT = 0 # Specifies that the default settings should be used. ## The defaults are: #~ * Speak the given text string synchronously #~ * Not purge pending speak requests #~ * Parse the text as XML only if the first character is a left-angle-bracket (<) #~ * Not persist global XML state changes across speak calls #~ * Not expand punctuation characters into words. $SPF_ASYNC = 1 # Specifies that the Speak call should be asynchronous. $SPF_PURGEBEFORESPEAK = 2 # Purges all pending speak requests prior to this speak call. $SPF_IS_FILENAME = 4 # The string passed is a file name, and the file text should be spoken. $SPF_IS_XML = 8 # The input text will be parsed for XML markup. $SPF_IS_NOT_XML= 16 # The input text will not be parsed for XML markup. $SPF = $SPF_DEFAULT if (!$wait) { $SPF += $SPF_ASYNC } if ($purge) { $SPF += $SPF_PURGEBEFORESPEAK } if ($readfiles){ $SPF += $SPF_IS_FILENAME } if ($readxml) { $SPF += $SPF_IS_XML } if ($notxml) { $SPF += $SPF_IS_NOT_XML } $Voice = New-Object -Com SAPI.SpVoice } process { foreach ($obj in $InputObject) { $str = $obj | Out-String $exit = $Voice.Speak($str, $SPF) } } } <# .SYNOPSIS Stops a process on a remote machine. .DESCRIPTION Stops a process on a remote machine. This command uses WMI to terminate the remote process. .PARAMETER ComputerName The name of the remote computer that the process is executing on. Type the NetBIOS name, an IP address, or a fully qualified domain name of the remote computer. .PARAMETER Name The process name of the remote process to terminate. .PARAMETER Id The process id of the remote process to terminate. .PARAMETER Credential Specifies a user account that has permission to perform this action. The default is the current user. Type a user name, such as "User01", "Domain01\User01", or User@Contoso.com. Or, enter a PSCredential object, such as an object that is returned by the Get-Credential cmdlet. When you type a user name, you will be prompted for a password. .EXAMPLE C:\PS> Stop-RemoteProcess server1 notepad.exe Stops all processes named notepad.exe on the remote computer server1. .EXAMPLE C:\PS> Stop-RemoteProcess server1 3478 Stops the process with process id 3478 on the remote computer server1. .EXAMPLE C:\PS> 3478,4005 | Stop-RemoteProcess server1 Stops the processes with process ids 3478 and 4005 on the remote computer server1. .NOTES Author: Jachym Kouba and Keith Hill #> function Stop-RemoteProcess { [CmdletBinding(SupportsShouldProcess=$true)] param( [Parameter(Position=0, Mandatory=$true)] [string] $ComputerName, [Parameter(Position=1, Mandatory=$true, ValueFromPipeline=$true, ParameterSetName="Name")] [string[]] $Name, [Parameter(Position=1, Mandatory=$true, ValueFromPipeline=$true, ValueFromPipelineByPropertyName=$true, ParameterSetName="Id")] [int[]] $Id, [System.Management.Automation.PSCredential] $Credential ) Process { $params = @{ Class = 'Win32_Process' ComputerName = $ComputerName } if ($Credential) { $params.Credential = $Credential } if ($pscmdlet.ParameterSetName -eq 'Name') { foreach ($item in $Name) { if (!$pscmdlet.ShouldProcess("process $item on computer $ComputerName")) { continue } $params.Filter = "Name LIKE '%$item%'" Get-WmiObject @params | Foreach { if ($_.Terminate().ReturnValue -ne 0) { Write-Error "Failed to stop process $item on $ComputerName." } } } } else { foreach ($item in $Id) { if (!$pscmdlet.ShouldProcess("process id $item on computer $ComputerName")) { continue } $params.Filter = "ProcessId = $item" Get-WmiObject @params | Foreach { if ($_.Terminate().ReturnValue -ne 0) { Write-Error "Failed to stop process id $item on $ComputerName." } } } } } } <# .SYNOPSIS Generate CSS header for HTML "screen shot" of the host buffer. .DESCRIPTION Generate CSS header for HTML "screen shot" of the host buffer. .EXAMPLE C:\PS> $css = Get-ScreenCss Gets the color info of the host's screen into CSS form. .NOTES Author: Jachym Kouba #> function Get-ScreenCss { param() Process { '<style>' [Enum]::GetValues([ConsoleColor]) | Foreach { " .F$_ { color: $_; }" " .B$_ { background-color: $_; }" } '</style>' } } <# .SYNOPSIS Functions to generate HTML "screen shot" of the host buffer. .DESCRIPTION Functions to generate HTML "screen shot" of the host buffer. .PARAMETER Count The number of lines of the host buffer to create a screen shot from. .EXAMPLE C:\PS> Get-ScreenHtml > screen.html Generates an HTML representation of the host's screen buffer and saves it to file. .EXAMPLE C:\PS> Get-ScreenHtml 25 > screen.html Generates an HTML representation of the first 25 lines of the host's screen buffer and saves it to file. .NOTES Author: Jachym Kouba #> function Get-ScreenHtml { param($Count = $Host.UI.RawUI.WindowSize.Height) Begin { # Required by HttpUtility Add-Type -Assembly System.Web $raw = $Host.UI.RawUI $buffsz = $raw.BufferSize function BuildHtml($out, $buff) { function OpenElement($out, $fore, $back) { & { $out.Append('<span class="F').Append($fore) $out.Append(' B').Append($back).Append('">') } | out-null } function CloseElement($out) { $out.Append('</span>') | out-null } $height = $buff.GetUpperBound(0) $width = $buff.GetUpperBound(1) $prev = $null $whitespaceCount = 0 $out.Append("<pre class=`"B$($Host.UI.RawUI.BackgroundColor)`">") | out-null for ($y = 0; $y -lt $height; $y++) { for ($x = 0; $x -lt $width; $x++) { $current = $buff[$y, $x] if ($current.Character -eq ' ') { $whitespaceCount++ write-debug "whitespaceCount: $whitespaceCount" } else { if ($whitespaceCount) { write-debug "appended $whitespaceCount spaces, whitespaceCount: 0" $out.Append((new-object string ' ', $whitespaceCount)) | out-null $whitespaceCount = 0 } if ((-not $prev) -or ($prev.ForegroundColor -ne $current.ForegroundColor) -or ($prev.BackgroundColor -ne $current.BackgroundColor)) { if ($prev) { CloseElement $out } OpenElement $out $current.ForegroundColor $current.BackgroundColor } $char = [System.Web.HttpUtility]::HtmlEncode($current.Character) $out.Append($char) | out-null $prev = $current } } $out.Append("`n") | out-null $whitespaceCount = 0 } if($prev) { CloseElement $out } $out.Append('</pre>') | out-null } } Process { $cursor = $raw.CursorPosition $rect = new-object Management.Automation.Host.Rectangle 0, ($cursor.Y - $Count), $buffsz.Width, $cursor.Y $buff = $raw.GetBufferContents($rect) $out = new-object Text.StringBuilder BuildHtml $out $buff $out.ToString() } } <# .SYNOPSIS Function to call a single method on an incoming stream of piped objects. .DESCRIPTION Function to call a single method on an incoming stream of piped objects. Methods can be static or instance and arguments may be passed as an array or individually. .PARAMETER InputObject The object to execute the named method on. Accepts pipeline input. .PARAMETER MemberName The member to execute on the passed object. .PARAMETER Arguments The arguments to pass to the named method, if any. .PARAMETER Static The member name will be treated as a static method call on the incoming object. .EXAMPLE C:\PS> 1..3 | invoke-method gettype Calls GetType() on each incoming integer. .EXAMPLE C:\PS> dir *.txt | invoke-method moveto "c:\temp\" Calls the MoveTo() method on all txt files in the current directory passing in "C:\Temp" as the destFileName. .NOTES Aliases: call #> function Invoke-Method { [CmdletBinding()] param( [parameter(valuefrompipeline=$true, mandatory=$true)] [allownull()] [allowemptystring()] $InputObject, [parameter(position=0, mandatory=$true)] [validatenotnullorempty()] [string]$MethodName, [parameter(valuefromremainingarguments=$true)] [allowemptycollection()] [object[]]$Arguments, [parameter()] [switch]$Static ) Process { if ($InputObject) { if ($InputObject | Get-Member $methodname -static:$static) { $flags = "ignorecase,public,invokemethod" if ($Static) { $flags += ",static" } else { $flags += ",instance" } if ($InputObject -is [type]) { $target = $InputObject } else { $target = $InputObject.gettype() } try { $target.invokemember($methodname, $flags, $null, $InputObject, $arguments) } catch { if ($_.exception.innerexception -is [missingmethodexception]) { write-warning "Method argument count (or type) mismatch." } } } else { write-warning "Method $methodname not found." } } } } <# .SYNOPSIS Sets a file's read only status to false making it writable. .DESCRIPTION Sets a file's read only status to false making it writable. .PARAMETER LiteralPath Specifies the path to a file make writable. Unlike Path, the value of LiteralPath is used exactly as it is typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell Windows PowerShell not to interpret any characters as escape sequences. .PARAMETER Path The path to the file make writable. Wildcards are accepted. .PARAMETER PassThru Passes the pipeline input object down the pipeline. By default, this cmdlet does not generate any output. .EXAMPLE C:\PS> Set-Writable foo.txt Makes foo.txt writable. .EXAMPLE C:\PS> Set-Writable [a-h]*.txt -passthru Makes any .txt file start with the letters a thru h writable and passes the filenames down the pipeline. .EXAMPLE C:\PS> Get-ChildItem bar[0-9].txt | Set-Writable Set-Writable can accept pipeline input corresponding to files and make them all writable. #> function Set-Writable { [CmdletBinding(DefaultParameterSetName="Path", SupportsShouldProcess=$true)] param( [Parameter(Position=0, Mandatory=$true, ValueFromPipeline=$true, ParameterSetName="Path")] [ValidateNotNullOrEmpty()] [string[]] $Path, [Alias("PSPath")] [Parameter(Position=0, Mandatory=$true, ValueFromPipelineByPropertyName=$true, ParameterSetName="LiteralPath")] [ValidateNotNullOrEmpty()] [string[]] $LiteralPath, [switch] $PassThru ) Process { $resolvedPaths = @() if ($psCmdlet.ParameterSetName -eq "Path") { # In the non-literal case we may need to resolve a wildcarded path foreach ($apath in $Path) { if (Test-Path $apath) { $resolvedPaths += @(Resolve-Path $apath | Foreach { $_.Path }) } else { Write-Error "File $apath does not exist" } } } else { $resolvedPaths += $LiteralPath } foreach ($rpath in $resolvedPaths) { $PathIntrinsics = $ExecutionContext.SessionState.Path if ($PathIntrinsics.IsProviderQualified($rpath)) { $rpath = $PathIntrinsics.GetUnresolvedProviderPathFromPSPath($rpath) } if (!(Test-Path $rpath -PathType Leaf)) { Write-Error "$rpath is not a file." continue } $fileInfo = New-Object System.IO.FileInfo $rpath if ($pscmdlet.ShouldProcess("$fileInfo")) { $fileInfo.IsReadOnly = $false } if ($PassThru) { $fileInfo } } } } <# .SYNOPSIS Sets a file's read only status to true making it read only. .DESCRIPTION Sets a file's read only status to true making it read only. .PARAMETER LiteralPath Specifies the path to a file make read only. Unlike Path, the value of LiteralPath is used exactly as it is typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell Windows PowerShell not to interpret any characters as escape sequences. .PARAMETER Path The path to the file make read only. Wildcards are accepted. .PARAMETER PassThru Passes the pipeline input object down the pipeline. By default, this cmdlet does not generate any output. .EXAMPLE C:\PS> Set-ReadOnly foo.txt Makes foo.txt read only. .EXAMPLE C:\PS> Set-ReadOnly [a-h]*.txt -passthru Makes any .txt file start with the letters a thru h read only and passes the filenames down the pipeline. .EXAMPLE C:\PS> Get-ChildItem bar[0-9].txt | Set-ReadOnly Set-ReadOnly can accept pipeline input corresponding to files and make them all read only. #> function Set-ReadOnly { [CmdletBinding(DefaultParameterSetName="Path", SupportsShouldProcess=$true)] param( [Parameter(Position=0, Mandatory=$true, ValueFromPipeline=$true, ParameterSetName="Path")] [ValidateNotNullOrEmpty()] [string[]] $Path, [Alias("PSPath")] [Parameter(Position=0, Mandatory=$true, ValueFromPipelineByPropertyName=$true, ParameterSetName="LiteralPath")] [ValidateNotNullOrEmpty()] [string[]] $LiteralPath, [switch] $PassThru ) Process { $resolvedPaths = @() if ($psCmdlet.ParameterSetName -eq "Path") { # In the non-literal case we may need to resolve a wildcarded path foreach ($apath in $Path) { if (Test-Path $apath) { $resolvedPaths += @(Resolve-Path $apath | Foreach { $_.Path }) } else { Write-Error "File $apath does not exist" } } } else { $resolvedPaths += $LiteralPath } foreach ($rpath in $resolvedPaths) { $PathIntrinsics = $ExecutionContext.SessionState.Path if ($PathIntrinsics.IsProviderQualified($rpath)) { $rpath = $PathIntrinsics.GetUnresolvedProviderPathFromPSPath($rpath) } if (!(Test-Path $rpath -PathType Leaf)) { Write-Error "$rpath is not a file." continue } $fileInfo = New-Object System.IO.FileInfo $rpath if ($pscmdlet.ShouldProcess("$fileInfo")) { $fileInfo.IsReadOnly = $true } if ($PassThru) { $fileInfo } } } } <# .SYNOPSIS Shows the specified path as a tree. .DESCRIPTION Shows the specified path as a tree. This works for any type of PowerShell provider and can be used to explore providers used for configuration like the WSMan provider. .PARAMETER Path The path to the root of the tree that will be shown. .PARAMETER Depth Specifies how many levels of the specified path are recursed and shown. .PARAMETER IndentSize The size of the indent per level. The default is 3. Minimum value is 1. .PARAMETER Force Allows the command to show items that cannot otherwise not be accessed by the user, such as hidden or system files. Implementation varies from provider to provider. For more information, see about_Providers. Even using the Force parameter, the command cannot override security restrictions. .PARAMETER ShowLeaf Shows the leaf items in each container. .PARAMETER ShowProperty Shows the properties on containers and items (if -ShowLeaf is specified). .PARAMETER ExcludeProperty List of properties to exclude from output. Only used when -ShowProperty is specified. .PARAMETER Width Specifies the number of characters in each line of output. Any additional characters are truncated, not wrapped. If you omit this parameter, the width is determined by the characteristics of the host. The default for the PowerShell.exe host is 80 (characters). .PARAMETER UseAsciiLineArt Displays line art using only ASCII characters. .EXAMPLE C:\PS> Show-Tree C:\Users -Depth 2 Shows the directory tree structure, recursing down two levels. .EXAMPLE C:\PS> Show-Tree HKLM:\SOFTWARE\Microsoft\.NETFramework -Depth 2 -ShowProperty -ExcludeProperty 'SubKeyCount','ValueCount' Shows the hierarchy of registry keys and values (-ShowProperty), recursing down two levels. Excludes the standard regkey extended properties SubKeyCount and ValueCount from the output. .EXAMPLE C:\PS> Show-Tree WSMan: -ShowLeaf Shows all the container and leaf items in the WSMan: drive. #> function Show-Tree { [CmdletBinding(DefaultParameterSetName="Path")] param( [Parameter(Position=0, ParameterSetName="Path", ValueFromPipeline=$true, ValueFromPipelineByPropertyName=$true)] [ValidateNotNullOrEmpty()] [string[]] $Path, [Alias("PSPath")] [Parameter(Position=0, ParameterSetName="LiteralPath", ValueFromPipelineByPropertyName=$true)] [ValidateNotNullOrEmpty()] [string[]] $LiteralPath, [Parameter(Position = 1)] [ValidateRange(0, 2147483647)] [int] $Depth = [int]::MaxValue, [Parameter()] [switch] $Force, [Parameter()] [ValidateRange(1, 100)] [int] $IndentSize = 3, [Parameter()] [switch] $ShowLeaf, [Parameter()] [switch] $ShowProperty, [Parameter()] [string[]] $ExcludeProperty, [Parameter()] [ValidateRange(0, 2147483647)] [int] $Width, [Parameter()] [switch] $UseAsciiLineArt ) Begin { Set-StrictMode -Version Latest # Set default path if not specified if (!$Path -and $psCmdlet.ParameterSetName -eq "Path") { $Path = Get-Location } if ($Width -eq 0) { $Width = $host.UI.RawUI.BufferSize.Width } $asciiChars = @{ EndCap = '\' Junction = '|' HorizontalBar = '-' VerticalBar = '|' } $unicodeChars = @{ EndCap = '└' Junction = '├' HorizontalBar = '─' VerticalBar = '│' } if ($UseAsciiLineArt) { $lineChars = $asciiChars } else { $lineChars = $unicodeChars } function GetIndentString([bool[]]$IsLast) { $str = '' for ($i=0; $i -lt $IsLast.Count - 1; $i++) { $str += if ($IsLast[$i]) {' '} else {$lineChars.VerticalBar} $str += " " * ($IndentSize - 1) } $str += if ($IsLast[-1]) {$lineChars.EndCap} else {$lineChars.Junction} $str += $lineChars.HorizontalBar * ($IndentSize - 1) $str } function CompactString([string]$String, [int]$MaxWidth = $Width) { $updatedString = $String if ($String.Length -ge $MaxWidth) { $ellipsis = '...' $updatedString = $String.Substring(0, $MaxWidth - $ellipsis.Length - 1) + $ellipsis } $updatedString } function ShowItemText([string]$ItemPath, [string]$ItemName, [bool[]]$IsLast) { if ($IsLast.Count -eq 0) { $itemText = Resolve-Path -LiteralPath $ItemPath | Foreach {$_.Path} CompactString $itemText } else { $itemText = $ItemName if (!$itemText) { if ($ExecutionContext.SessionState.Path.IsProviderQualified($ItemPath)) { $itemText = $ExecutionContext.SessionState.Path.GetUnresolvedProviderPathFromPSPath($ItemPath) } } CompactString "$(GetIndentString $IsLast)$itemText" } } function ShowPropertyText ([string]$Name, [string]$Value, [bool[]]$IsLast) { $cookedValue = @($Value -split "`n")[0].Trim() CompactString "$(GetIndentString $IsLast)Property: $Name = $cookedValue" } function ShowItem([string]$ItemPath, [string]$ItemName='', [bool[]]$IsLast=@()) { $isContainer = Test-Path -LiteralPath $ItemPath -Type Container if (!($isContainer -or $ShowLeaf)) { Write-Warning "Path is not a container, use the ShowLeaf parameter to show leaf items." return } # Show current item ShowItemText $ItemPath $ItemName $IsLast # If the item is a container, grab its children. This let's us know if there # will be items after the last property at the same level. $childItems = @() if ($isContainer -and ($IsLast.Count -lt $Depth)) { $childItems = @(Get-ChildItem -LiteralPath $ItemPath -Force:$Force -ErrorAction $ErrorActionPreference | Where {$ShowLeaf -or $_.PSIsContainer} | Select PSPath, PSChildName) } # Track parent's "last item" status to determine which level gets a vertical bar $IsLast += @($false) # If requested, show item properties if ($ShowProperty) { $excludedProviderNoteProps = 'PSIsContainer','PSChildName','PSDrive','PSParentPath','PSPath','PSProvider','Name','Property' $excludedProviderNoteProps += $ExcludeProperty $props = @() $itemProp = Get-ItemProperty -LiteralPath $ItemPath -ErrorAction SilentlyContinue if ($itemProp) { $props = @($itemProp.psobject.properties | Sort Name | Where {$excludedProviderNoteProps -notcontains $_.Name}) } else { $item = $null # Have to use try/catch here because Get-Item cert: error caught be caught with -EA try { $item = Get-Item -LiteralPath $ItemPath -ErrorAction SilentlyContinue } catch {} if ($item) { $props = @($item.psobject.properties | Sort Name | Where {$excludedProviderNoteProps -notcontains $_.Name}) } } for ($i=0; $i -lt $props.Count; $i++) { $IsLast[-1] = ($i -eq $props.count -1) -and ($childItems.Count -eq 0) $prop = $props[$i] ShowPropertyText $prop.Name $prop.Value $IsLast } } # Recurse through child items for ($i=0; $i -lt $childItems.Count; $i++) { $childItemPath = $childItems[$i].PSPath $childItemName = $childItems[$i].PSChildName $IsLast[-1] = ($i -eq $childItems.Count - 1) if ($ShowLeaf -or (Test-Path -LiteralPath $childItemPath -Type Container)) { ShowItem $childItemPath $childItemName $IsLast } } } } Process { if ($psCmdlet.ParameterSetName -eq "Path") { # In the -Path (non-literal) resolve path in case it is wildcarded. $resolvedPaths = @($Path | Resolve-Path | Foreach {"$_"}) } else { # Must be -LiteralPath $resolvedPaths = @($LiteralPath) } foreach ($rpath in $resolvedPaths) { Write-Verbose "Processing $rpath" ShowItem $rpath } } } <# .Synopsis Enumerates the parameters of one or more commands. .Description Lists all the parameters of a command, by ParameterSet, including their aliases, type, etc. By default, formats the output to tables grouped by command and parameter set. .Parameter CommandName The name of the command to get parameters for. .Parameter ParameterName Wilcard-enabled filter for parameter names. .Parameter ModuleName The name of the module which contains the command (this is for scoping) .Parameter SkipProviderParameters Skip testing for Provider parameters (will be much faster) .Parameter SetName The ParameterSet name to filter by (allows wildcards) .Parameter Force Forces including the CommonParameters in the output. .Example Get-Command Select-Xml | Get-Parameter .Example Get-Parameter Select-Xml .Notes With many thanks to Hal Rottenberg, Oisin Grehan and Shay Levy Version 0.80 - April 2008 - By Hal Rottenberg http://poshcode.org/186 Version 0.81 - May 2008 - By Hal Rottenberg http://poshcode.org/255 Version 0.90 - June 2008 - By Hal Rottenberg http://poshcode.org/445 Version 0.91 - June 2008 - By Oisin Grehan http://poshcode.org/446 Version 0.92 - April 2008 - By Hal Rottenberg http://poshcode.org/549 - ADDED resolving aliases and avoided empty output Version 0.93 - Sept 24, 2009 - By Hal Rottenberg http://poshcode.org/1344 Version 1.0 - Jan 19, 2010 - By Joel Bennett http://poshcode.org/1592 - Merged Oisin and Hal's code with my own implementation - ADDED calculation of dynamic paramters Version 2.0 - July 22, 2010 - By Joel Bennett http://poshcode.org/get/2005 - CHANGED uses FormatData so the output is objects - ADDED calculation of shortest names to the aliases (idea from Shay Levy http://poshcode.org/1982, but with a correct implementation) Version 2.1 - July 22, 2010 - By Joel Bennett http://poshcode.org/2007 - FIXED Help for SCRIPT file (script help must be separated from #Requires by an emtpy line) - Fleshed out and added dates to this version history after Bergle's criticism ;) Version 2.2 - July 29, 2010 - By Joel Bennett http://poshcode.org/2030 - FIXED a major bug which caused Get-Parameters to delete all the parameters from the CommandInfo Version 2.3 - July 29, 2010 - By Joel Bennett - ADDED a ToString ScriptMethod which allows queries like: $parameters = Get-Parameter Get-Process; $parameters -match "Name" Version 2.4 - July 29, 2010 - By Joel Bennett http://poshcode.org/2032 - CHANGED "Name" to CommandName - ADDED ParameterName parameter to allow filtering parameters - FIXED bug in 2.3 and 2.2 with dynamic parameters Version 2.5 - December 13, 2010 - By Jason Archer http://poshcode.org/2404 - CHANGED format temp file to have static name, prevents bloat of random temporary files Version 2.6 - July 23, 2011 - By Jason Archer (This Version) - FIXED miscalculation of shortest unique name (aliases count as unique names), this caused some parameter names to be thrown out (like "Object") - CHANGED code style cleanup Version 2.7 - November 28, 2012 - By Joel Bennett http://poshcode.org/3794 - Added * indicator on default parameter set. Version 2.8 - August 27, 2013 - By Joel Bennett (This Version) - Added SetName filter - Add * on the short name in the aliases list (to distinguish it from real aliases) - FIXED PowerShell 4 Bugs: - Added PipelineVariable to CommonParameters - FIXED PowerShell 3 Bugs: - Don't add to the built-in Aliases anymore, it changes the command! Version 2.9 - July 13, 2015 - By Joel Bennett (This Version) - FIXED (hid) exceptions when looking for dynamic parameters - CHANGE to only search for provider parameters on Microsoft.PowerShell.Management commands (BUG??) - ADDED SkipProviderParameters switch to manually disable looking for provider parameters (faster!) - ADDED "Name" alias for CommandName to fix piping Get-Command output #> function Get-Parameter { [CmdletBinding(DefaultParameterSetName="ParameterName")] param( [Parameter(Position = 1, Mandatory = $true, ValueFromPipelineByPropertyName = $true)] [Alias("Name")] [string[]]$CommandName, [Parameter(Position = 2, ValueFromPipelineByPropertyName=$true, ParameterSetName="FilterNames")] [string[]]$ParameterName = "*", [Parameter(ValueFromPipelineByPropertyName=$true, ParameterSetName="FilterSets")] [string[]]$SetName = "*", [Parameter(ValueFromPipelineByPropertyName = $true)] $ModuleName, [Switch]$SkipProviderParameters, [switch]$Force ) begin { $PropertySet = @( "Name", @{n="Position";e={if($_.Position -lt 0){"Named"}else{$_.Position}}}, "Aliases", @{n="Short";e={$_.Name}}, @{n="Type";e={$_.ParameterType.Name}}, @{n="ParameterSet";e={$paramset}}, @{n="Command";e={$command}}, @{n="Mandatory";e={$_.IsMandatory}}, @{n="Provider";e={$_.DynamicProvider}}, @{n="ValueFromPipeline";e={$_.ValueFromPipeline}}, @{n="ValueFromPipelineByPropertyName";e={$_.ValueFromPipelineByPropertyName}} ) function Join-Object { Param( [Parameter(Position=0)] $First, [Parameter(ValueFromPipeline=$true,Position=1)] $Second ) begin { [string[]] $p1 = $First | Get-Member -MemberType Properties | Select-Object -ExpandProperty Name } process { $Output = $First | Select-Object $p1 foreach ($p in $Second | Get-Member -MemberType Properties | Where-Object {$p1 -notcontains $_.Name} | Select-Object -ExpandProperty Name) { Add-Member -InputObject $Output -MemberType NoteProperty -Name $p -Value $Second."$p" } $Output } } function Add-Parameters { [CmdletBinding()] param( [Parameter(Position=0)] [Hashtable]$Parameters, [Parameter(Position=1)] [System.Management.Automation.ParameterMetadata[]]$MoreParameters, [Parameter(Position=2)] [System.Management.Automation.ProviderInfo]$Provider ) foreach ($p in $MoreParameters | Where-Object { !$Parameters.ContainsKey($_.Name) } ) { Write-Debug ("INITIALLY: " + $p.Name) $Parameters.($p.Name) = $p | Select * } if ($Provider) { [Array]$Dynamic = $MoreParameters | Where-Object { $_.IsDynamic } if ($dynamic) { foreach ($d in $dynamic) { if (Get-Member -InputObject $Parameters.($d.Name) -Name DynamicProvider) { Write-Debug ("ADD:" + $d.Name + " " + $Provider.Name) $Parameters.($d.Name).DynamicProvider += $Provider.Name } else { Write-Debug ("CREATE:" + $d.Name + " " + $Provider.Name) $Parameters.($d.Name) = $Parameters.($d.Name) | Select *, @{ n="DynamicProvider";e={ @($Provider.Name) } } } } } } } } process { foreach ($cmd in $CommandName) { if ($ModuleName) {$cmd = "$ModuleName\$cmd"} Write-Verbose "Searching for $cmd" $commands = @(Get-Command $cmd) foreach ($command in $commands) { Write-Verbose "Searching for $command" # resolve aliases (an alias can point to another alias) while ($command.CommandType -eq "Alias") { $command = @(Get-Command ($command.definition))[0] } if (-not $command) {continue} if ($PSVersionTable.PSVersion.Major -ge 5) { Write-Verbose "Get-Parameters for $($Command.Source)\$($Command.Name)" $isCoreCommand = $Command.Source -eq "Microsoft.PowerShell.Management" } else { Write-Verbose "Get-Parameters for $($Command.ModuleName)\$($Command.Name)" $isCoreCommand = $Command.ModuleName -eq "Microsoft.PowerShell.Management" } $Parameters = @{} ## We need to detect provider parameters ... $NoProviderParameters = !$SkipProviderParameters ## Shortcut: assume only the core commands get Provider dynamic parameters if(!$SkipProviderParameters -and $isCoreCommand) { ## The best I can do is to validate that the command has a parameter which could accept a string path foreach($param in $Command.Parameters.Values) { if(([String[]],[String] -contains $param.ParameterType) -and ($param.ParameterSets.Values | Where { $_.Position -ge 0 })) { $NoProviderParameters = $false break } } } if($NoProviderParameters) { if($Command.Parameters) { Add-Parameters $Parameters $Command.Parameters.Values } } else { foreach ($provider in Get-PSProvider) { if($provider.Drives.Count -gt 0) { $drive = Get-Location -PSProvider $Provider.Name } else { $drive = "{0}\{1}::\" -f $provider.ModuleName, $provider.Name } Write-Verbose ("Get-Command $command -Args $drive | Select -Expand Parameters") $MoreParameters = @() try { $MoreParameters = (Get-Command $command -Args $drive).Parameters.Values } catch {} if($MoreParameters.Count -gt 0) { Add-Parameters $Parameters $MoreParameters $provider } } # If for some reason none of the drive paths worked, just use the default parameters if($Parameters.Count -eq 0) { if($Command.Parameters) { Add-Parameters $Parameters $Command.Parameters.Values $provider } } } ## Calculate the shortest distinct parameter name -- do this BEFORE removing the common parameters or else. $Aliases = $Parameters.Values | Select-Object -ExpandProperty Aliases ## Get defined aliases $ParameterNames = $Parameters.Keys + $Aliases foreach ($p in $($Parameters.Keys)) { $short = "^" $aliases = @($p) + @($Parameters.$p.Aliases) | sort { $_.Length } $shortest = "^" + @($aliases)[0] foreach($name in $aliases) { $short = "^" foreach ($char in [char[]]$name) { $short += $char $mCount = ($ParameterNames -match $short).Count if ($mCount -eq 1 ) { if($short.Length -lt $shortest.Length) { $shortest = $short } break } } } if($shortest.Length -lt @($aliases)[0].Length +1){ # Overwrite the Aliases with this new value $Parameters.$p = $Parameters.$p | Add-Member NoteProperty Aliases ($Parameters.$p.Aliases + @("$($shortest.SubString(1))*")) -Force -Passthru } } # Write-Verbose "Parameters: $($Parameters.Count)`n $($Parameters | ft | out-string)" $CommonParameters = [string[]][System.Management.Automation.Cmdlet]::CommonParameters foreach ($paramset in @($command.ParameterSets | Select-Object -ExpandProperty "Name")) { $paramset = $paramset | Add-Member -Name IsDefault -MemberType NoteProperty -Value ($paramset -eq $command.DefaultParameterSet) -PassThru foreach ($parameter in $Parameters.Keys | Sort-Object) { # Write-Verbose "Parameter: $Parameter" if (!$Force -and ($CommonParameters -contains $Parameter)) {continue} if ($Parameters.$Parameter.ParameterSets.ContainsKey($paramset) -or $Parameters.$Parameter.ParameterSets.ContainsKey("__AllParameterSets")) { if ($Parameters.$Parameter.ParameterSets.ContainsKey($paramset)) { $output = Join-Object $Parameters.$Parameter $Parameters.$Parameter.ParameterSets.$paramSet } else { $output = Join-Object $Parameters.$Parameter $Parameters.$Parameter.ParameterSets.__AllParameterSets } Write-Output $Output | Select-Object $PropertySet | ForEach-Object { $null = $_.PSTypeNames.Insert(0,"System.Management.Automation.ParameterMetadata") $null = $_.PSTypeNames.Insert(0,"System.Management.Automation.ParameterMetadataEx") # Write-Verbose "$(($_.PSTypeNames.GetEnumerator()) -join ", ")" $_ } | Add-Member ScriptMethod ToString { $this.Name } -Force -Passthru | Where-Object {$(foreach($pn in $ParameterName) {$_ -like $Pn}) -contains $true} | Where-Object {$(foreach($sn in $SetName) {$_.ParameterSet -like $sn}) -contains $true} } } } } } } } <# .SYNOPSIS Imports environment variables for the specified version of Visual Studio. .DESCRIPTION Imports environment variables for the specified version of Visual Studio. This function requires the PowerShell Community Extensions. To find out the most recent set of Visual Studio environment variables imported use the cmdlet Get-EnvironmentBlock. If you want to revert back to a previous Visul Studio environment variable configuration use the cmdlet Pop-EnvironmentBlock. .PARAMETER VisualStudioVersion The version of Visual Studio to import environment variables for. Valid values are 2008, 2010, 2012, 2013, 2015, 2017 and 2019. .PARAMETER Architecture Selects the desired architecture to configure the environment for. If this parameter isn't specified, the command will attempt to locate and use VsDevCmd.bat. If VsDevCmd.bat can't be found (not installed) then the command will use vcvarsall.bat with either the argument x86 if running in 32-bit PowerShell or amd64 if running in 64-bit PowerShell. Other valid values are: arm, x86_arm, x86_amd64, amd64_x86. .PARAMETER RequireWorkload This parameter applies to Visual Studio 2017 and higher. It allows you to specify which workloads are required for the environment you desire to import. This can be used when you have multiple versions of Visual Studio 2017 installed and different versions support different workloads e.g. perhaps only the "Preview" version supports the Microsoft.VisualStudio.Component.VC.Tools.x86.x64 workload. .EXAMPLE C:\PS> Import-VisualStudioVars 2015 Sets up the environment variables to use the VS 2015 tools. If VsDevCmd.bat is found then it will use that. Otherwise, vcvarsall.bat will be used with an architecture of either x86 for 32-bit Powershell, or amd64 for 64-bit Powershell. .EXAMPLE C:\PS> Import-VisualStudioVars 2013 arm Sets up the environment variables for the VS 2013 ARM tools. .EXAMPLE C:\PS> Import-VisualStudioVars 2017 -Architecture amd64 -RequireWorkload Microsoft.VisualStudio.Component.VC.Tools.x86.x64 Finds an instance of VS 2017 that has the required workload and sets up the environment variables to use that instance of the VS 2017 tools. To see a full list of available workloads, execute: Get-VSSetupInstance | Foreach-Object Packages | Foreach-Object Id | Sort-Object #> function Import-VisualStudioVars { param ( [Parameter(Position = 0)] [ValidateSet('90', '2008', '100', '2010', '110', '2012', '120', '2013', '140', '2015', '150', '2017','160','2019')] [string] $VisualStudioVersion, [Parameter(Position = 1)] [string] $Architecture, [Parameter()] [ValidateNotNullOrEmpty()] [string[]] $RequireWorkload ) begin { $ArchSpecified = $true if (!$Architecture) { $ArchSpecified = $false $Architecture = $(if ($Pscx:Is64BitProcess) {'amd64'} else {'x86'}) } function GetSpecifiedVSSetupInstance($Version, [switch]$Latest, [switch]$FailOnMissingVSSetup) { if ((Get-Module -Name VSSetup -ListAvailable) -eq $null) { Write-Warning "You must install the VSSetup module to import Visual Studio variables for Visual Studio 2017 or higher." Write-Warning "Install the VSSetup module with the command: Install-Module VSSetup -Scope CurrentUser" if ($FailOnMissingVSSetup) { throw "VSSetup module is not installed, unable to import Visual Studio 2017 (or higher) environment variables." } else { # For the default (no VS version specified) case, we can look for earlier versions of VS. return $null } } Import-Module VSSetup -ErrorAction Stop $selectArgs = @{ Product = '*' } if ($Latest) { $selectArgs['Latest'] = $true } elseif ($Version) { $selectArgs['Version'] = $Version } if ($RequireWorkload -or $ArchSpecified) { if (!$RequireWorkload) { # We get here when the architecture was specified but no worload, most likely these users want the C++ workload $RequireWorkload = 'Microsoft.VisualStudio.Component.VC.Tools.x86.x64' } $selectArgs['Require'] = $RequireWorkload } Write-Verbose "$($MyInvocation.MyCommand.Name) Select-VSSetupInstance args:" Write-Verbose "$(($selectArgs | Out-String) -split "`n")" $vsInstance = Get-VSSetupInstance | Select-VSSetupInstance @selectArgs | Select-Object -First 1 $vsInstance } function FindAndLoadBatchFile($ComnTools, $ArchSpecified, [switch]$IsAppxInstall) { $batchFilePath = Join-Path $ComnTools VsDevCmd.bat if (!$ArchSpecified -and (Test-Path -LiteralPath $batchFilePath)) { if ($IsAppxInstall) { # The newer batch files spit out a header that tells you which environment was loaded # so only write out the below message when -Verbose is specified. Write-Verbose "Invoking '$batchFilePath'" } else { "Invoking '$batchFilePath'" } Invoke-BatchFile $batchFilePath } else { if ($IsAppxInstall) { $batchFilePath = Join-Path $ComnTools ..\..\VC\Auxiliary\Build\vcvarsall.bat # The newer batch files spit out a header that tells you which environment was loaded # so only write out the below message when -Verbose is specified. Write-Verbose "Invoking '$batchFilePath' $Architecture" } else { $batchFilePath = Join-Path $ComnTools ..\..\VC\vcvarsall.bat "Invoking '$batchFilePath' $Architecture" } Invoke-BatchFile $batchFilePath $Architecture } } } end { switch -regex ($VisualStudioVersion) { '90|2008' { Push-EnvironmentBlock -Description "Before importing VS 2008 $Architecture environment variables" Write-Verbose "Invoking ${env:VS90COMNTOOLS}..\..\VC\vcvarsall.bat $Architecture" Invoke-BatchFile "${env:VS90COMNTOOLS}..\..\VC\vcvarsall.bat" $Architecture } '100|2010' { Push-EnvironmentBlock -Description "Before importing VS 2010 $Architecture environment variables" Write-Verbose "Invoking ${env:VS100COMNTOOLS}..\..\VC\vcvarsall.bat $Architecture" Invoke-BatchFile "${env:VS100COMNTOOLS}..\..\VC\vcvarsall.bat" $Architecture } '110|2012' { Push-EnvironmentBlock -Description "Before importing VS 2012 $Architecture environment variables" FindAndLoadBatchFile $env:VS110COMNTOOLS $ArchSpecified } '120|2013' { Push-EnvironmentBlock -Description "Before importing VS 2013 $Architecture environment variables" FindAndLoadBatchFile $env:VS120COMNTOOLS $ArchSpecified } '140|2015' { Push-EnvironmentBlock -Description "Before importing VS 2015 $Architecture environment variables" FindAndLoadBatchFile $env:VS140COMNTOOLS $ArchSpecified } '150|2017' { $vsInstance = GetSpecifiedVSSetupInstance -Version '[15.0,16.0)' -FailOnMissingVSSetup if (!$vsInstance) { throw "No instances of Visual Studio 2017 found$(if ($RequireWorkload) {" for the required workload: $RequireWorkload"})." } Push-EnvironmentBlock -Description "Before importing VS 2017 $Architecture environment variables" $installPath = $vsInstance.InstallationPath FindAndLoadBatchFile "$installPath/Common7/Tools" $ArchSpecified -IsAppxInstall } '160|2019' { $vsInstance = GetSpecifiedVSSetupInstance -Version '[16.0,17.0)' -FailOnMissingVSSetup if (!$vsInstance) { throw "No instances of Visual Studio 2019 found$(if ($RequireWorkload) {" for the required workload: $RequireWorkload"})." } Push-EnvironmentBlock -Description "Before importing VS 2019 $Architecture environment variables" $installPath = $vsInstance.InstallationPath FindAndLoadBatchFile "$installPath/Common7/Tools" $ArchSpecified -IsAppxInstall } default { $vsInstance = GetSpecifiedVSSetupInstance -Latest if ($vsInstance) { Push-EnvironmentBlock -Description "Before importing $($vsInstance.DisplayName) $Architecture environment variables" $installPath = $vsInstance.InstallationPath FindAndLoadBatchFile "$installPath/Common7/Tools" $ArchSpecified -IsAppxInstall } else { $envvar = @(Get-Item Env:\vs*comntools | Sort-Object { $_.Name -replace '(?<=VS)(\d)(0)','0$1$2'} -Descending)[0] if (!$envvar) { throw "No versions of Visual Studio found." } Push-EnvironmentBlock -Description "Before importing $($envvar.Name) $Architecture environment variables" FindAndLoadBatchFile ($envvar.Value) $ArchSpecified } } } } } <# .SYNOPSIS Starts a new Windows PowerShell process. .DESCRIPTION Starts a new Windows PowerShell process using PowerShell's parameter parsing engine to parse the parameters for the PowerShell executable. This command exposes a few of the Start-Process commands it uses such as -Wait, -Credential and -WorkingDirectory. Note: If -NoNewWindow is specified, PowerShell is invoked using the call operator (&) instead of with the Start-Process cmdlet. .PARAMETER PSConsoleFile Loads the specified Windows PowerShell console file. To create a console file, use Export-Console in Windows PowerShell. .PARAMETER Version Starts the specified version of Windows PowerShell. Enter a version number with the parameter, such as "-version 2.0". .PARAMETER ExecutionPolicy Sets the default execution policy for the current session and saves it in the $env:PSExecutionPolicyPreference environment variable. This parameter does not change the Windows PowerShell execution policy that is set in the registry. .PARAMETER Architecture Starts PowerShell with the desired architecture: x86, x64 or same architecture as the launching PowerShell process. Valid values are: x86, x64 and Same. .PARAMETER NoLogo Hides the copyright banner at startup. .PARAMETER NoExit Does not exit after running startup commands. .PARAMETER Sta Starts the shell using a single-threaded apartment. Single-threaded apartment (STA) is the default. .PARAMETER Mta Start the shell using a multithreaded apartment. .PARAMETER NoProfile Does not load the Windows PowerShell profile. .PARAMETER NonInteractive Does not present an interactive prompt to the user. .PARAMETER InputFormat Describes the format of data sent to Windows PowerShell. Valid values are "Text" (text strings) or "XML" (serialized CLIXML format). .PARAMETER OutputFormat Determines how output from Windows PowerShell is formatted. Valid values are "Text" (text strings) or "XML" (serialized CLIXML format). .PARAMETER Credential Specifies a user account that has permission to perform this action. Type a user-name, such as "User01" or "Domain01\User01", or enter a PSCredential object, such as one from the Get-Credential cmdlet. By default, the cmdlet uses the credentials of the current user. This parameter can't be used in conjunction with the NoNewWindow parameter. .PARAMETER WindowStyle Sets the window style to Normal, Minimized, Maximized or Hidden. This parameter can't be used in conjunction with the NoNewWindow parameter. .PARAMETER NoNewWindow Uses the call invocation operator to start PowerShell instead of Start-Process. This parameter can't be used in conjunction with the WindowStyle parameter. .PARAMETER WorkingDirectory Specifies the location of the executable file or document that runs in the process. The default is the current directory. .PARAMETER Wait Waits for the specified process to complete before accepting more input. This parameter suppresses the command prompt or retains the window until the process completes. .PARAMETER EncodedCommand Accepts a base-64-encoded string version of a command. Use this parameter to submit commands to Windows PowerShell that require complex quotation marks or curly braces. .PARAMETER File Runs the specified script in the local scope ("dot-sourced"), so that the functions and variables that the script creates are available in the current session. Enter the script file path and any parameters. File must be the last parameter in the command, because all characters typed after the File parameter name are interpreted as the script file path followed by the script parameters. .PARAMETER Command Executes the specified commands (and any parameters) as though they were typed at the Windows PowerShell command prompt, and then exits, unless NoExit is specified. The value of Command can be "-", a string. or a script block. If the value of Command is "-", the command text is read from standard input. If the value of Command is a script block, the script block must be enclosed in braces ({}). You can specify a script block only when running PowerShell.exe in Windows PowerShell. The results of the script block are returned to the parent shell as deserialized XML objects, not live objects. If the value of Command is a string, Command must be the last parameter in the command , because any characters typed after the command are interpreted as the command arguments. To write a string that runs a Windows PowerShell command, use the format: "& {<command>}" where the quotation marks indicate a string and the invoke operator (&) causes the command to be executed. .EXAMPLE C:\PS> Start-PowerShell -NoProfile -NoExit -File $pwd\foo.ps1 .EXAMPLE C:\PS> Start-PowerShell -NoProfile -NoLogo -Credential (Get-Credential) .EXAMPLE C:\PS> Start-PowerShell -NoProfile -NoNewWindow -File $pwd\foo.ps1 .EXAMPLE C:\PS> Start-PowerShell -Architecture x64 -NoNewWindow -Command {[IntPtr]::Size} .EXAMPLE C:\PS> Start-PowerShell -Architecture x86 -NoNewWindow -Command {[IntPtr]::Size} #> function Start-PowerShell { param( [Parameter(Position = 0)] [ValidateSet(2.0,3.0)] [double] $Version, [Parameter()] [ValidateSet('x86','x64','Same')] [string] $Architecture, [Parameter()] $Command, [Parameter()] [PSCredential] $Credential, [Parameter()] [string] $WorkingDirectory, [Parameter()] [switch] $Wait, [Parameter()] [string] $PSConsoleFile, [Parameter()] [Microsoft.PowerShell.ExecutionPolicy] $ExecutionPolicy, [Parameter()] [Alias('PSPath')] [string] $File, [Parameter()] [string] $EncodedCommand, [Parameter()] [ValidateSet('text','xml')] [string] $InputFormat, [Parameter()] [ValidateSet('text','xml')] [string] $OutputFormat, [Parameter()] [ValidateSet('Normal','Minimized','Maximized','Hidden')] [string] $WindowStyle, [Parameter()] [Alias('NE')] [switch] $NoExit, [Parameter()] [Alias('NL')] [switch] $NoLogo, [Parameter()] [Alias('NP')] [switch] $NoProfile, [Parameter()] [switch] $NoNewWindow, [Parameter()] [Alias('NI')] [switch] $NonInteractive, [Parameter()] [switch] $Mta, [Parameter()] [switch] $Sta, [Parameter(ValueFromRemainingArguments=$true)] [string[]] $Arguments ) Begin { Set-StrictMode -Version Latest $PowerShellPath = "$env:windir\System32\WindowsPowerShell\v1.0\powershell.exe" if ($pscx:IsWow64Process -and ($Architecture -eq 'x64')) { $PowerShellPath = "$env:windir\SysNative\WindowsPowerShell\v1.0\powershell.exe" } if ($pscx:Is64BitProcess -and ($Architecture -eq 'x86')) { $PowerShellPath = "$env:windir\SysWow64\WindowsPowerShell\v1.0\powershell.exe" } } End { [string[]]$arglist = @() if ($PSConsoleFile) { $arglist += '-PSConsoleFile',$PSConsoleFile } if ($Version) { $arglist += '-Version',$Version } if ($NoLogo) { $arglist += '-NoLogo' } if ($NoExit) { $arglist += '-NoExit' } if ($Sta) { $arglist += '-Sta' } if ($Mta) { $arglist += '-Mta' } if ($NoProfile) { $arglist += '-NoProfile' } if ($NonInteractive) { $arglist += '-NonInteractive' } if ($WindowStyle) { $arglist += '-WindowStyle',$WindowStyle } if ($ExecutionPolicy) { $arglist += '-ExecutionPolicy',$ExecutionPolicy } if ($File) { $arglist += '-File',$File if ($Arguments -and $Arguments.Count -gt 0) { $arglist += $Arguments } } elseif ($Command) { $arglist += '-Command',$Command if ($Arguments -and $Arguments.Count -gt 0) { $arglist += $Arguments } } elseif ($EncodedCommand) { $arglist += '-EncodedCommand',$EncodedCommand } $pscmdlet.WriteDebug("Start-PowerShell: Path to PowerShell - $PowerShellPath") if ($NoNewWindow) { $OFS = "`n" $pscmdlet.WriteDebug("Start-PowerShell: Call operator arguments -`n$($arglist | Out-String)") # Doing a start-process -NoNewWindow on PowerShell results in a shell that doesn't want to exit on V3 at least. & $PowerShellPath $arglist } else { $startProcessArgs = @{} if ($arglist.Count -gt 0) { $startProcessArgs['ArgumentList'] = $arglist } if ($Credential) { $startProcessArgs['Credential'] = $Credential } if ($WorkingDirectory) { $startProcessArgs['WorkingDirectory'] = $WorkingDirectory } if ($Wait) { $startProcessArgs['Wait'] = $true } $pscmdlet.WriteDebug("Start-PowerShell: Arguments to Start-Process - $($startProcessArgs | Out-String)") Microsoft.PowerShell.Management\Start-Process $PowerShellPath @startProcessArgs } } } <# .SYNOPSIS Gets the execution time for the specified Id of a command in the current session history. .DESCRIPTION Gets the execution time for the specified Id of a command in the current session history. .PARAMETER Id Specifies the Id of the command to retrieve the execution time. If no Id is specified, then the execution time for all commands in the history is displayed. .EXAMPLE C:\PS> Get-ExecutionTime 1 Gets the execution time for id #1 in the session history. .EXAMPLE C:\PS> Get-ExecutionTime Gets the execution time for all commands in the session history. #> function Get-ExecutionTime { param( [Parameter(Position = 0)] [ValidateScript({$_ -ge 1})] [Int64] $Id ) End { Get-History @PSBoundParameters | Foreach { $obj = new-object psobject -Property @{ Id = $_.Id ExecutionTime = ($_.EndExecutionTime - $_.StartExecutionTime) HistoryInfo = $_ } $obj.PSTypeNames.Insert(0, 'Pscx.Commands.Modules.Utility.ExecutionTimeInfo') $obj } } } Export-ModuleMember -Alias * -Function * |