Limit the width on all Out-String calls to that of a 16-bit signed integer.

We had an issue with this in `Resolve-ADTErrorRecord`. Best that we apply this consistently everywhere.

Author: mjr4077au

examples/Multi-session Installation/Invoke-AppDeployToolkit.ps1

@@ -198,7 +198,7 @@ try
 }
 catch
 {
-    $Host.UI.WriteErrorLine((Out-String -InputObject $_ -Width ([System.Int32]::MaxValue)))
+    $Host.UI.WriteErrorLine((Out-String -InputObject $_ -Width ([System.Int16]::MaxValue)))
     exit 60008
 }
 

examples/VLC/Invoke-AppDeployToolkit.ps1

@@ -321,7 +321,7 @@ try
 }
 catch
 {
-    $Host.UI.WriteErrorLine((Out-String -InputObject $_ -Width ([System.Int32]::MaxValue)))
+    $Host.UI.WriteErrorLine((Out-String -InputObject $_ -Width ([System.Int16]::MaxValue)))
     exit 60008
 }
 

examples/WinSCP/Invoke-AppDeployToolkit.ps1

@@ -330,7 +330,7 @@ try
 }
 catch
 {
-    $Host.UI.WriteErrorLine((Out-String -InputObject $_ -Width ([System.Int32]::MaxValue)))
+    $Host.UI.WriteErrorLine((Out-String -InputObject $_ -Width ([System.Int16]::MaxValue)))
     exit 60008
 }
 

src/PSAppDeployToolkit.Build/Private/Invoke-ADTMarkdownExport.ps1

@@ -201,7 +201,7 @@ function Invoke-ADTMarkdownExport
         {
             for ($i = 0; $i -lt $MissingDocumentation.Count; $i++)
             {
-                $output = ($MissingDocumentation[$i] | Select-Object -Property FileName, LineNumber, Line | Format-List -Property * | Out-String -Width ([System.Int32]::MaxValue)).Trim().Split([System.String[]]("`r`n", "`n"), [System.StringSplitOptions]::None).Trim() -replace '^', "> "
+                $output = ($MissingDocumentation[$i] | Select-Object -Property FileName, LineNumber, Line | Format-List -Property * | Out-String -Width ([System.Int16]::MaxValue)).Trim().Split([System.String[]]("`r`n", "`n"), [System.StringSplitOptions]::None).Trim() -replace '^', "> "
                 Write-ADTBuildLogEntry -Message "Output for missing documentation MatchInfo [$($i+1)/$($MissingDocumentation.Count)]" -ForegroundColor DarkRed
                 Write-ADTBuildLogEntry -Message $output -ForegroundColor DarkRed
             }

src/PSAppDeployToolkit.Build/Private/Write-ADTScriptAnalyzerOutput.ps1

@@ -17,7 +17,7 @@ function Write-ADTScriptAnalyzerOutput
     # Write each result out to the console.
     for ($i = 0; $i -lt $DiagnosticRecord.Count; $i++)
     {
-        $output = ($DiagnosticRecord[$i] | Format-List -Property * | Out-String -Width ([System.Int32]::MaxValue)).Split([System.String[]]("`r`n", "`n"), [System.StringSplitOptions]::None).Trim() -replace '^', "> "
+        $output = ($DiagnosticRecord[$i] | Format-List -Property * | Out-String -Width ([System.Int16]::MaxValue)).Split([System.String[]]("`r`n", "`n"), [System.StringSplitOptions]::None).Trim() -replace '^', "> "
         Write-ADTBuildLogEntry -Message "Output for Invoke-ScriptAnalyzer DiagnosticRecord [$($i+1)/$($DiagnosticRecord.Count)]" -ForegroundColor DarkRed
         Write-ADTBuildLogEntry -Message $output -ForegroundColor DarkRed
     }

src/PSAppDeployToolkit/Public/Get-ADTPendingReboot.ps1

@@ -137,7 +137,7 @@ function Get-ADTPendingReboot
                     $PendingFileRenameOperations,
                     $PendRebootErrorMsg.AsReadOnly()
                 )
-                Write-ADTLogEntry -Message "Pending reboot status on the local computer [$HostName]:`n$($PendingRebootInfo | Format-List | Out-String -Width ([System.Int32]::MaxValue))"
+                Write-ADTLogEntry -Message "Pending reboot status on the local computer [$HostName]:`n$($PendingRebootInfo | Format-List | Out-String -Width ([System.Int16]::MaxValue))"
                 return $PendingRebootInfo
             }
             catch

src/PSAppDeployToolkit/Public/Initialize-ADTFunction.ps1

@@ -94,7 +94,7 @@ function Initialize-ADTFunction
         Write-ADTLogEntry -Message 'Function Start' -Source $Cmdlet.MyInvocation.MyCommand.Name -DebugMessage
         if ($Cmdlet.MyInvocation.BoundParameters.Count)
         {
-            $CmdletBoundParameters = $Cmdlet.MyInvocation.BoundParameters | Format-Table -Property @{ Label = 'Parameter'; Expression = { "[-$($_.Key)]" } }, @{ Label = 'Value'; Expression = { $_.Value }; Alignment = 'Left' }, @{ Label = 'Type'; Expression = { if ($_.Value) { $_.Value.GetType().Name } }; Alignment = 'Left' } -AutoSize -Wrap | Out-String -Width ([System.Int32]::MaxValue)
+            $CmdletBoundParameters = $Cmdlet.MyInvocation.BoundParameters | Format-Table -Property @{ Label = 'Parameter'; Expression = { "[-$($_.Key)]" } }, @{ Label = 'Value'; Expression = { $_.Value }; Alignment = 'Left' }, @{ Label = 'Type'; Expression = { if ($_.Value) { $_.Value.GetType().Name } }; Alignment = 'Left' } -AutoSize -Wrap | Out-String -Width ([System.Int16]::MaxValue)
             Write-ADTLogEntry -Message "Function invoked with bound parameter(s):`n$CmdletBoundParameters" -Source $Cmdlet.MyInvocation.MyCommand.Name -DebugMessage
         }
         else

src/PSAppDeployToolkit/Public/New-ADTTemplate.ps1

@@ -210,7 +210,7 @@ function New-ADTTemplate
                         LiteralPath = "$templatePath\Invoke-AppDeployToolkit.ps1"
                         Encoding = ('utf8', 'utf8BOM')[$PSVersionTable.PSEdition.Equals('Core')]
                     }
-                    Out-File -InputObject (Get-Content @params -Raw).Replace('..\..\..\..\', [System.Management.Automation.Language.NullString]::Value).Replace('2000-12-31', [System.DateTime]::Now.ToString('O').Split('T')[0]) @params -Width ([System.Int32]::MaxValue) -Force
+                    Out-File -InputObject (Get-Content @params -Raw).Replace('..\..\..\..\', [System.Management.Automation.Language.NullString]::Value).Replace('2000-12-31', [System.DateTime]::Now.ToString('O').Split('T')[0]) @params -Width ([System.Int16]::MaxValue) -Force
                 }
                 else
                 {

src/PSAppDeployToolkit/Public/Resolve-ADTErrorRecord.ps1

@@ -200,7 +200,7 @@ function Resolve-ADTErrorRecord
         }
 
         # Build out error properties.
-        $logErrorMessage = [System.String]::Join([System.Environment]::NewLine, "Error Record:", "-------------", $null, (Out-String -InputObject (Format-List -InputObject ([pscustomobject]$logErrorProperties)) -Width ([System.Int32]::MaxValue)).Trim())
+        $logErrorMessage = [System.String]::Join([System.Environment]::NewLine, "Error Record:", "-------------", $null, (Out-String -InputObject (Format-List -InputObject ([pscustomobject]$logErrorProperties)) -Width ([System.Int16]::MaxValue)).Trim())
 
         # Capture Error Inner Exception(s).
         if ($IncludeErrorInnerException -and $ErrorRecord.Exception -and $ErrorRecord.Exception.InnerException)
@@ -219,7 +219,7 @@ function Resolve-ADTErrorRecord
                 }
 
                 # Add error record and get next inner exception.
-                $innerExceptions.Add(($errInnerException | Select-Object -Property ($errInnerException | Get-ErrorPropertyNames) | Format-List | Out-String -Width ([System.Int32]::MaxValue)).Trim())
+                $innerExceptions.Add(($errInnerException | Select-Object -Property ($errInnerException | Get-ErrorPropertyNames) | Format-List | Out-String -Width ([System.Int16]::MaxValue)).Trim())
                 $errInnerException = $errInnerException.InnerException
             }
 

src/PSAppDeployToolkit/Public/Show-ADTHelpConsole.ps1

@@ -66,7 +66,7 @@ function Show-ADTHelpConsole
                     $help = [System.Collections.Generic.Dictionary[System.String, System.String]]::new()
                     foreach ($exportedCommand in $_.ExportedCommands.Keys)
                     {
-                        $help.Add($exportedCommand, [System.String]::Join([System.Environment]::NewLine, ((Get-Help -Name $exportedCommand -Full | Out-String -Width ([System.Int32]::MaxValue) -Stream) -replace '^\s+$').TrimEnd()).Trim().Replace('<br />', [System.Management.Automation.Language.NullString]::Value) + [System.Environment]::NewLine)
+                        $help.Add($exportedCommand, [System.String]::Join([System.Environment]::NewLine, ((Get-Help -Name $exportedCommand -Full | Out-String -Width ([System.Int16]::MaxValue) -Stream) -replace '^\s+$').TrimEnd()).Trim().Replace('<br />', [System.Management.Automation.Language.NullString]::Value) + [System.Environment]::NewLine)
                     }
 
                     # Add the dictionary of commands and their help to the collector.