Private/Get-ScriptEnd.ps1
|
<#
.Synopsis Created on: 21/10/2023 Created by: Ben Whitmore Filename: Get-ScriptEnd.ps1 .Description Function to exit script .PARAMETER LogId The component (script name) passed as LogID to the 'Write-Log' function. This parameter is built from the line number of the call from the function up the .PARAMETER ErrorMessage The error message passed to the 'Get-ScriptEnd' function #> function Get-ScriptEnd { [CmdletBinding()] param ( [Parameter(Mandatory = $false, ValuefromPipeline = $false, HelpMessage = "The component (script name) passed as LogID to the 'Write-Log' function")] [string]$LogId = $($MyInvocation.MyCommand).Name, [Parameter(Mandatory = $false, ValuefromPipeline = $false, Position = 0, HelpMessage = "The error message passed to the 'Get-ScriptEnd' function")] [string]$ErrorMessage ) process { if ($ErrorMessage) { Write-Log -Message ("'{0}'" -f $ErrorMessage) -LogId $LogId -Severity 3 Write-Warning -Message ("'{0}'" -f $ErrorMessage) } } end { Set-Location -Path $ScriptRoot Write-Host '' Write-Log -Message "## The Win32AppMigrationTool Script has Finished ##" -LogId $LogId Write-Host '## The Win32AppMigrationTool Script has Finished ##' break } } |