Public/Get-ADTShortcut.ps1
|
#----------------------------------------------------------------------------- # # MARK: Get-ADTShortcut # #----------------------------------------------------------------------------- function Get-ADTShortcut { <# .SYNOPSIS Get information from a .lnk or .url type shortcut. .DESCRIPTION Get information from a .lnk or .url type shortcut. Returns a hashtable with details about the shortcut such as TargetPath, Arguments, Description, and more. .PARAMETER Path Path to the shortcut to get information from. .INPUTS None You cannot pipe objects to this function. .OUTPUTS System.Collections.Hashtable Returns a hashtable with the following keys: - TargetPath - Arguments - Description - WorkingDirectory - WindowStyle - Hotkey - IconLocation - IconIndex - RunAsAdmin .EXAMPLE Get-ADTShortcut -Path "$envProgramData\Microsoft\Windows\Start Menu\My Shortcut.lnk" Retrieves information from the specified .lnk shortcut. .NOTES An active ADT session is NOT required to use this function. Url shortcuts only support TargetPath, IconLocation, and IconIndex. Tags: psadt Website: https://psappdeploytoolkit.com Copyright: (C) 2024 PSAppDeployToolkit Team (Sean Lillis, Dan Cunningham, Muhammad Mashwani, Mitch Richters, Dan Gough). License: https://opensource.org/license/lgpl-3-0 .LINK https://psappdeploytoolkit.com #> [CmdletBinding()] [OutputType([PSADT.Types.ShortcutUrl])] [OutputType([PSADT.Types.ShortcutLnk])] param ( [Parameter(Mandatory = $true, Position = 0)] [ValidateScript({ if (![System.IO.File]::Exists($_) -or (![System.IO.Path]::GetExtension($Path).ToLower().Equals('.lnk') -and ![System.IO.Path]::GetExtension($Path).ToLower().Equals('.url'))) { $PSCmdlet.ThrowTerminatingError((New-ADTValidateScriptErrorRecord -ParameterName Path -ProvidedValue $_ -ExceptionMessage 'The specified path does not exist or does not have the correct extension.')) } return ![System.String]::IsNullOrWhiteSpace($_) })] [System.String]$Path ) begin { # Make this function continue on error. Initialize-ADTFunction -Cmdlet $PSCmdlet -SessionState $ExecutionContext.SessionState -ErrorAction SilentlyContinue } process { # Make sure .NET's current directory is synced with PowerShell's. try { try { [System.IO.Directory]::SetCurrentDirectory((Get-Location -PSProvider FileSystem).ProviderPath) $Output = @{ Path = [System.IO.Path]::GetFullPath($Path); TargetPath = $null; IconIndex = $null; IconLocation = $null } } catch { Write-Error -ErrorRecord $_ } } catch { Invoke-ADTFunctionErrorHandler -Cmdlet $PSCmdlet -SessionState $ExecutionContext.SessionState -ErrorRecord $_ -LogMessage "Specified path [$Path] is not valid." return } try { try { # Build out remainder of object. if ($Path -match '\.url$') { [System.IO.File]::ReadAllLines($Path) | & { process { switch ($_) { { $_.StartsWith('URL=') } { $Output.TargetPath = $_.Replace('URL=', $null); break } { $_.StartsWith('IconIndex=') } { $Output.IconIndex = $_.Replace('IconIndex=', $null); break } { $_.StartsWith('IconFile=') } { $Output.IconLocation = $_.Replace('IconFile=', $null); break } } } } return [PSADT.Types.ShortcutUrl]::new( $Output.Path, $Output.TargetPath, $Output.IconIndex, $Output.IconLocation ) } else { $shortcut = [System.Activator]::CreateInstance([System.Type]::GetTypeFromProgID('WScript.Shell')).CreateShortcut($FullPath) $Output.IconLocation, $Output.IconIndex = $shortcut.IconLocation.Split(',') return [PSADT.Types.ShortcutLnk]::new( $Output.Path, $shortcut.TargetPath, $Output.IconIndex, $Output.IconLocation, $shortcut.Arguments, $shortcut.Description, $shortcut.WorkingDirectory, $(switch ($shortcut.WindowStyle) { 1 { 'Normal'; break } 3 { 'Maximized'; break } 7 { 'Minimized'; break } default { 'Normal'; break } }), $shortcut.Hotkey, !!([Systen.IO.FIle]::ReadAllBytes($FullPath)[21] -band 32) ) } } catch { Write-Error -ErrorRecord $_ } } catch { Invoke-ADTFunctionErrorHandler -Cmdlet $PSCmdlet -SessionState $ExecutionContext.SessionState -ErrorRecord $_ -LogMessage "Failed to read the shortcut [$Path]." } } end { Complete-ADTFunction -Cmdlet $PSCmdlet } } |