Private/Set-FunctionDisplay.ps1
|
Function Set-FunctionDisplay { <# .Synopsis Nice display PsBoundParameters .DESCRIPTION This function formats and displays the PsBoundParameters hashtable in a visually appealing way for Verbose output. .EXAMPLE Set-FunctionDisplay $PsBoundParameters .EXAMPLE Set-FunctionDisplay -HashTable $PsBoundParameters .PARAMETER HashTable Hashtable variable from calling function containing PsBoundParameters to format accordingly .PARAMETER TabCount Amount of Tabs to be used on the formatting. .NOTES Used Functions: Name | Module ---------------------------------------|-------------------------- .NOTES Version: 1.0 DateModified: 20/Oct/2022 LasModifiedBy: Vicente Rodriguez Eguibar vicente@eguibar.com Eguibar IT http://www.eguibarit.com #> [CmdletBinding(SupportsShouldProcess = $false, ConfirmImpact = 'Low')] [OutputType([Hashtable])] Param ( [Parameter(Mandatory = $true, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, HelpMessage = 'Hashtable variable from calling function containing PsBoundParameters to format accordingly', Position = 0)] [ValidateNotNullOrEmpty()] [Hashtable] $HashTable, [Parameter(Mandatory = $false, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, HelpMessage = 'Amount of Tabs to be used on the formatting.', Position = 1)] [ValidateNotNullOrEmpty()] [int] $TabCount = 4 ) Begin { # Validate TabCount and set default if needed if ($TabCount -lt 1) { $TabCount = 4 } } # end Begin Process { # Display PSBoundparameters formatted nicely for Verbose output $display = '' # Validate if HashTable is not empty if ($HashTable.Count -gt 0) { # Get hashtable formatted properly $pb = $HashTable | Format-Table -AutoSize | Out-String # Add corresponding tabs and new lines to each table member $display += $pb -split $Constants.NewLine | ForEach-Object { "$($Constants.HorizontalTab * $TabCount)$_" } | Out-String } else { $display = "No PsBoundParameters to display." } #end If } # end Process End { Return $display } #end END } #end Function |