docs: finalize error handling standard

This commit is contained in:
DrIOS
2024-06-16 12:48:15 -05:00
parent 51edc331ab
commit 46d71900ce
3 changed files with 12 additions and 6 deletions

View File

@@ -15,7 +15,10 @@ function Get-ExceededLengthResultDetail {
[Parameter(Mandatory = $true, ParameterSetName = 'ReturnExceedingTests')]
[switch]$ReturnExceedingTestsOnly,
[int]$DetailsLengthLimit = 30000
[int]$DetailsLengthLimit = 30000,
[Parameter(Mandatory = $true, ParameterSetName = 'UpdateArray')]
[int]$PreviewLineCount = 50
)
$exceedingTests = @()
@@ -28,11 +31,14 @@ function Get-ExceededLengthResultDetail {
if ($ReturnExceedingTestsOnly) {
$exceedingTests += $auditResult.Rec
} else {
$previewLines = ($auditResult.Details -split '\r?\n' | Select-Object -First $PreviewLineCount) -join "`n"
$message = "The test result is too large to be exported to CSV. Use the audit result and the export function for full output.`n`nPreview:`n$previewLines"
if ($ExportedTests -contains $auditResult.Rec) {
Write-Information "The test result for $($auditResult.Rec) is too large for CSV and was included in the export. Check the exported files."
$auditResult.Details = "The test result is too large to be exported to CSV. Use the audit result and the export function for full output."
$auditResult.Details = $message
} else {
$auditResult.Details = "The test result is too large to be exported to CSV. Use the audit result and the export function for full output."
$auditResult.Details = $message
}
}
}