Skip to content

Latest commit

 

History

History
130 lines (107 loc) · 3.71 KB

PowerShell - QuickAccess Utilities.md

File metadata and controls

130 lines (107 loc) · 3.71 KB
Raw

PowerShell - QuickAccess Utilities

Source: https://gist.github.com/014f18d00bea1c63ca5da34fa66a71e0#file-quickaccess-psm1

	Function Set-QuickAccessFromCfg {
  <#
    .SYNOPSIS
    This function pins a path to Quick Access in Windows Explorer.
    .DESCRIPTION
    This function in details:
    * takes a path list to pin from a configruation file,
    * pins a path to Quick Access in Windows Explorer
    .PARAMETER CfgFile
    Configuration file.
    .LINK
    https://github.com/a4099181/vagrant-provvin/blob/master/docs/Set-QuickAccessFromCfg.md
    .LINK
    https://github.com/a4099181/vagrant-provvin/blob/master/modules/set-quickaccess.psm1
    .LINK
    https://gallery.technet.microsoft.com/Set-QuickAccess-117e9a89
#>
  Param ( [Parameter(Mandatory = $true)][String] $CfgFile )

  $cfg = Get-Content $CfgFile | ConvertFrom-Json

  if ( $cfg.quick_access ) {
    $cfg.quick_access |
    ForEach-Object { Set-QuickAccess -Action Pin -Path ([System.Environment]::ExpandEnvironmentVariables( $_  )) }
  }
}

Function Set-QuickAccess {
  ###################
  # Set-QuickAccess #
  ###################
  #Version: 2017-08-10.01
  #Author: [email protected]

  <#

.SYNOPSIS
Pin or Unpin folders to/from Quick Access in File Explorer.

.DESCRIPTION
Pin or Unpin folders to/from Quick Access in File Explorer.

.EXAMPLE
.\Set-QuickAccess.ps1 -Action Pin -Path "\\server\share\redirected_folders\$env:USERNAME\Links"
Pin the specified UNC server share to Quick Access in File Explorer.

.EXAMPLE
.\Set-QuickAccess.ps1 -Action Unpin -Path "\\server\share\redirected_folders\$env:USERNAME\Links"
Unpin the specified UNC server share from Quick Access in File Explorer.

.NOTES
Thanks to the below sources for inspiration :)
https://blogs.technet.microsoft.com/heyscriptingguy/2013/04/26/use-powershell-to-work-with-windows-explorer/
https://www.reddit.com/r/sysadmin/comments/6g5hz4/removing_pinned_quick_access_pins_via_powershell/

.LINK
https://gallery.technet.microsoft.com/Set-QuickAccess-117e9a89

#>

  [CmdletBinding()]
  Param
  (
    [Parameter(Mandatory = $true, Position = 1, HelpMessage = "Pin or Unpin folder to/from Quick Access in File Explorer.")]
    [ValidateSet("Pin", "Unpin")]
    [string]$Action,
    [Parameter(Mandatory = $true, Position = 2, HelpMessage = "Path to the folder to Pin or Unpin to/from Quick Access in File Explorer.")]
    [string]$Path
  )

  Write-Host "$Action to/from Quick Access: $Path.. " -NoNewline

  #Check if specified path is valid
  If ((Test-Path -Path $Path) -ne $true) {
    Write-Warning "Path does not exist."
    return
  }
  #Check if specified path is a folder
  If ((Test-Path -Path $Path -PathType Container) -ne $true) {
    Write-Warning "Path is not a folder."
    return
  }

  #Pin or Unpin
  $QuickAccess = New-Object -ComObject shell.application
  $TargetObject = $QuickAccess.Namespace("shell:::{679f85cb-0220-4080-b29b-5540cc05aab6}").Items() | where { $_.Path -eq "$Path" }
  If ($Action -eq "Pin") {
    If ($TargetObject -ne $null) {
      Write-Warning "Path is already pinned to Quick Access."
      return
    }
    Else {
      $QuickAccess.Namespace("$Path").Self.InvokeVerb("pintohome")
    }
  }
  ElseIf ($Action -eq "Unpin") {
    If ($TargetObject -eq $null) {
      Write-Warning "Path is not pinned to Quick Access."
      return
    }
    Else {
      $TargetObject.InvokeVerb("unpinfromhome")
    }
  }

  Write-Host "Done"
}

Appendix: Links

Backlinks:

list from [[PowerShell - QuickAccess Utilities]] AND -"Changelog"