Functions/ConvertTo-UncPath.ps1

# source: https://www.powershellgallery.com/packages/PPoShTools/1.0.19

function ConvertTo-UncPath {
<#
.SYNOPSIS
    A simple function to convert a local file path and a computer name to a network UNC path.
.PARAMETER LocalFilePath
    A file path ie. C:\Windows\somefile.txt
.PARAMETER Computername
    One or more computers in which the file path exists on
.EXAMPLE
    ConvertTo-UncPath -LocalFilePath 'c:\adminTools\SomeFolder' -ComputerName 'SomeRemoteComputer'
    \\SomeRemoteComputer\c$\adminTools\SomeFolder
.EXAMPLE
    ConvertTo-UncPath -LocalFilePath 'c:\adminTools\SomeFolder' -ComputerName 'SomeRemoteComputer','SomeAnotherComputer'
    \\SomeRemoteComputer\c$\adminTools\SomeFolder
    \\SomeAnotherComputer\c$\adminTools\SomeFolder
.OUTPUTS
    Will create a string for remote computer path
#>

    [CmdletBinding()]
    [OutputType('String')]
    param (
        [Parameter(Mandatory,HelpMessage='Add help message for user', ValueFromPipeline,ValueFromPipelineByPropertyName)]
        [Alias('LocalFilePath')]
        [string] $Path,

        [Parameter()]
        [string[]] $ComputerName = $env:COMPUTERNAME
    )
    process {
        try {
            foreach ($Computer in $ComputerName) {
                $RemoteFilePathDrive = ($Path | Split-Path -Qualifier).TrimEnd(':')
                "\\$Computer\$RemoteFilePathDrive`$$($Path | Split-Path -NoQualifier)"
            }
        }
        catch {
            Write-Log -Error -Message $_.Exception.Message
        }
    }
}