Unpacking Software Livestream

Join our monthly Unpacking Software livestream to hear about the latest news, chat and opinion on packaging, software deployment and lifecycle management!

Learn More

Chocolatey Product Spotlight

Join the Chocolatey Team on our regular monthly stream where we put a spotlight on the most recent Chocolatey product releases. You'll have a chance to have your questions answered in a live Ask Me Anything format.

Learn More

Chocolatey Coding Livestream

Join us for the Chocolatey Coding Livestream, where members of our team dive into the heart of open source development by coding live on various Chocolatey projects. Tune in to witness real-time coding, ask questions, and gain insights into the world of package management. Don't miss this opportunity to engage with our team and contribute to the future of Chocolatey!

Learn More

Calling All Chocolatiers! Whipping Up Windows Automation with Chocolatey Central Management

Webinar from
Wednesday, 17 January 2024

We are delighted to announce the release of Chocolatey Central Management v0.12.0, featuring seamless Deployment Plan creation, time-saving duplications, insightful Group Details, an upgraded Dashboard, bug fixes, user interface polishing, and refined documentation. As an added bonus we'll have members of our Solutions Engineering team on-hand to dive into some interesting ways you can leverage the new features available!

Watch On-Demand
Chocolatey Community Coffee Break

Join the Chocolatey Team as we discuss all things Community, what we do, how you can get involved and answer your Chocolatey questions.

Watch The Replays
Chocolatey and Intune Overview

Webinar Replay from
Wednesday, 30 March 2022

At Chocolatey Software we strive for simple, and teaching others. Let us teach you just how simple it could be to keep your 3rd party applications updated across your devices, all with Intune!

Watch On-Demand
Chocolatey For Business. In Azure. In One Click.

Livestream from
Thursday, 9 June 2022

Join James and Josh to show you how you can get the Chocolatey For Business recommended infrastructure and workflow, created, in Azure, in around 20 minutes.

Watch On-Demand
The Future of Chocolatey CLI

Livestream from
Thursday, 04 August 2022

Join Paul and Gary to hear more about the plans for the Chocolatey CLI in the not so distant future. We'll talk about some cool new features, long term asks from Customers and Community and how you can get involved!

Watch On-Demand
Hacktoberfest Tuesdays 2022

Livestreams from
October 2022

For Hacktoberfest, Chocolatey ran a livestream every Tuesday! Re-watch Cory, James, Gary, and Rain as they share knowledge on how to contribute to open-source projects such as Chocolatey CLI.

Watch On-Demand

Downloads:

78

Downloads of v 1.0.0:

78

Last Update:

19 Aug 2023

Package Maintainer(s):

Software Author(s):

  • foundata

Tags:

usewindow.extension focus window non-silent user32.dll

Use-Window extension (helper to focus a window)

  • 1
  • 2
  • 3

1.0.0 | Updated: 19 Aug 2023

Downloads:

78

Downloads of v 1.0.0:

78

Maintainer(s):

Software Author(s):

  • foundata

Use-Window extension (helper to focus a window) 1.0.0

  • 1
  • 2
  • 3

All Checks are Passing

3 Passing Tests


Validation Testing Passed


Verification Testing Passed

Details

Scan Testing Successful:

No detections found in any package files

Details
Learn More

Deployment Method: Individual Install, Upgrade, & Uninstall

To install Use-Window extension (helper to focus a window), run the following command from the command line or from PowerShell:

>

To upgrade Use-Window extension (helper to focus a window), run the following command from the command line or from PowerShell:

>

To uninstall Use-Window extension (helper to focus a window), run the following command from the command line or from PowerShell:

>

Deployment Method:

NOTE

This applies to both open source and commercial editions of Chocolatey.

1. Enter Your Internal Repository Url

(this should look similar to https://community.chocolatey.org/api/v2/)


2. Setup Your Environment

1. Ensure you are set for organizational deployment

Please see the organizational deployment guide

2. Get the package into your environment

  • Open Source or Commercial:
    • Proxy Repository - Create a proxy nuget repository on Nexus, Artifactory Pro, or a proxy Chocolatey repository on ProGet. Point your upstream to https://community.chocolatey.org/api/v2/. Packages cache on first access automatically. Make sure your choco clients are using your proxy repository as a source and NOT the default community repository. See source command for more information.
    • You can also just download the package and push it to a repository Download

3. Copy Your Script

choco upgrade usewindow.extension -y --source="'INTERNAL REPO URL'" [other options]

See options you can pass to upgrade.

See best practices for scripting.

Add this to a PowerShell script or use a Batch script with tools and in places where you are calling directly to Chocolatey. If you are integrating, keep in mind enhanced exit codes.

If you do use a PowerShell script, use the following to ensure bad exit codes are shown as failures:


choco upgrade usewindow.extension -y --source="'INTERNAL REPO URL'" 
$exitCode = $LASTEXITCODE

Write-Verbose "Exit code was $exitCode"
$validExitCodes = @(0, 1605, 1614, 1641, 3010)
if ($validExitCodes -contains $exitCode) {
  Exit 0
}

Exit $exitCode

- name: Install usewindow.extension
  win_chocolatey:
    name: usewindow.extension
    version: '1.0.0'
    source: INTERNAL REPO URL
    state: present

See docs at https://docs.ansible.com/ansible/latest/modules/win_chocolatey_module.html.


chocolatey_package 'usewindow.extension' do
  action    :install
  source   'INTERNAL REPO URL'
  version  '1.0.0'
end

See docs at https://docs.chef.io/resource_chocolatey_package.html.


cChocoPackageInstaller usewindow.extension
{
    Name     = "usewindow.extension"
    Version  = "1.0.0"
    Source   = "INTERNAL REPO URL"
}

Requires cChoco DSC Resource. See docs at https://github.com/chocolatey/cChoco.


package { 'usewindow.extension':
  ensure   => '1.0.0',
  provider => 'chocolatey',
  source   => 'INTERNAL REPO URL',
}

Requires Puppet Chocolatey Provider module. See docs at https://forge.puppet.com/puppetlabs/chocolatey.


4. If applicable - Chocolatey configuration/installation

See infrastructure management matrix for Chocolatey configuration elements and examples.

Package Approved

This package was approved by moderator TheCakeIsNaOH on 21 Aug 2023.

Description

An unofficial Chocolatey extension providing helper functions for querying and focusing windows. These functions may be used in Chocolatey install and uninstall scripts by declaring this package a dependency in your package's .nuspec.

The most important function is Use-Window, which is able to focus a window and bring it to the front. A script can easily switch between windows this way.


extensions\Find-WindowHandle.ps1
function Find-WindowHandle {
    <#
    .SYNOPSIS
        Finds the handle of the window matching the given query. Returns an
        IntPtr matching the given query if a window is found or IntPtr.Zero
        otherwise.

    .PARAMETER Query
        A query that has one of the following formats:

        - A RegEx pattern that is tested against all existing windows.
        - A window handle.
        - A window title followed by its handle enclosed in parentheses.

    .EXAMPLE
        Find the handle of the first window having "powershell" somewhere
        in its name:

            Find-WindowHandle 'powershell'

    .EXAMPLE
        Find the handle of the first window named exactly "powershell":

            Find-WindowHandle '^powershell$'

    .EXAMPLE
        Return the given handle, if a window exists with this handle:

            Find-WindowHandle 10101010

    .EXAMPLE
        Return the given handle, if a window exists with the handle at the
        end of the given string:

            Find-WindowHandle 'powershell (10101010)'

    #>
    Param(
        [Parameter(Mandatory = $True,
                   HelpMessage = 'A RegEx pattern that is tested against all existing windows OR a window handle OR a window title followed by its handle enclosed in parentheses.')]
        [String]$Query
    )

    # find handle in title (either the whole title is the handle, or enclosed in parenthesis)
    if ($Query -match '^\d+$') {
        $Handle = [IntPtr]::new($Query)
    } elseif ($Query -match '^.+ \((\d+)\)\s*$') {
        $Handle = [IntPtr]::new($Matches[1])
    } else {

        # find handle in existing processes.
        $MatchingWindows = [UseWindowHelpers]::GetAllExistingWindows() | ? { $PSItem.Key -match $Query }

        if (-not $MatchingWindows) {
            return [IntPtr]::Zero
        }

        # no need to ensure the window does exist, return immediately
        return $MatchingWindows[0].Value
    }

    # make sure the handle exists
    if ([UseWindowHelpers]::WindowExists($Handle)) {
        return $Handle
    } else {
        return [IntPtr]::Zero
    }
}
extensions\Helper.ps1
Add-Type -Language 'CSharp' -ReferencedAssemblies @('System', 'System.Runtime.InteropServices') -TypeDefinition @"
    using System;
    using System.Collections.Generic;
    using System.Runtime.InteropServices;
    using System.Text;

    public static class UseWindowHelpers
    {
        [DllImport("user32.dll")]
        [return: MarshalAs(UnmanagedType.Bool)]
        private static extern bool SetForegroundWindow(IntPtr hWnd);

        [DllImport("user32.dll")]
        [return: MarshalAs(UnmanagedType.Bool)]
        private static extern bool ShowWindow(IntPtr hWnd, int nCmdShow);

        public static void BringToFront(IntPtr handle)
        {
            ShowWindow(handle, 5);
            SetForegroundWindow(handle);
        }


        [DllImport("user32.dll")]
        [return: MarshalAs(UnmanagedType.Bool)]
        private static extern bool GetWindowRect(IntPtr hWnd, out RECT lpRect);

        [StructLayout(LayoutKind.Sequential)]
        private struct RECT
        {
            public int Left, Top, Right, Bottom;
        }

        public static bool WindowExists(IntPtr handle)
        {
            RECT r;

            return GetWindowRect(handle, out r);
        }

        private delegate bool EnumDesktopWindowsDelegate(IntPtr hWnd, int lParam);

        [DllImport("user32.dll")]
        private static extern bool EnumDesktopWindows(IntPtr hDesktop, EnumDesktopWindowsDelegate lpfn, IntPtr lParam);

        [DllImport("user32.dll")]
        private static extern int GetWindowText(IntPtr hWnd, StringBuilder lpWindowText, int nMaxCount);

        public static List<KeyValuePair<string, IntPtr>> GetAllExistingWindows()
        {
            var windows = new List<KeyValuePair<string, IntPtr>>();

            EnumDesktopWindows(IntPtr.Zero, (h, _) =>
            {
                StringBuilder title = new StringBuilder(256);
                int titleLength = GetWindowText(h, title, 512);

                if (titleLength > 0)
                    windows.Add(new KeyValuePair<string, IntPtr>(title.ToString(), h));

                return true;
            }, IntPtr.Zero);

            return windows;
        }
    }
"@
extensions\Use-Window.ps1
function Use-Window {
    <#
    .SYNOPSIS
        Focuses the window having the given handle and brings it to the front.

    .PARAMETER Query
        A window title query that will be resolved using "Find-WindowHandle".

    .EXAMPLE
        Focus the first window having "powershell" somewhere in its name and
        bring it to the front:

            Use-Window "powershell"

    .EXAMPLE
        Focus the first window named exactly "powershell" and bring it to the
        front:

            Use-Window'^powershell$'
    #>
    Param(
        [Parameter(Mandatory = $True,
                   ValueFromPipeline = $True,
                   HelpMessage = 'A window title query that will be resolved using "Find-WindowHandle".')]
        [ValidateScript({
            if ( (Find-WindowHandle $PSItem) -eq 0 ) {
                Throw "Use-Window: Cannot find window handle for query '${PSItem}'."
            } else {
                $True
            }
        })]
        [String]$Query
    )

    $Handle = Find-WindowHandle $Query

    [UseWindowHelpers]::BringToFront($Handle)
}
extensions\usewindow.extension.psm1
$ErrorActionPreference = 'Stop' # stop on all errors

$scriptRoot = Split-Path $MyInvocation.MyCommand.Definition

# get currently defined functions (before dot sourcing additional .ps1 files)
$functionsBefore = Get-ChildItem 'Function:\*'

# dot source files whose names start with a capital letter, ignore others
Get-ChildItem "${scriptRoot}\*.ps1" | Where-Object { $PSItem.Name -cmatch '^[A-Z]+' } | ForEach-Object { . $PSItem  }

# get currently defined functions (after dot sourcing additional .ps1 files)
$functionsAfter = Get-ChildItem 'Function:\*'

# export functions whose names start with a capital letter, others are private
$functionsDiff = Compare-Object $functionsBefore $functionsAfter | Select-Object -ExpandProperty 'InputObject' | Select-Object -ExpandProperty 'Name'
$functionsDiff | Where-Object { $PSItem -cmatch '^[A-Z]+'} | ForEach-Object { Export-ModuleMember -Function $PSItem }

Log in or click on link to see number of positives.

In cases where actual malware is found, the packages are subject to removal. Software sometimes has false positives. Moderators do not necessarily validate the safety of the underlying software, only that a package retrieves software from the official distribution point and/or validate embedded software against official distribution point (where distribution rights allow redistribution).

Chocolatey Pro provides runtime protection from possible malware.

Add to Builder Version Downloads Last Updated Status

This package has no dependencies.

Discussion for the Use-Window extension (helper to focus a window) Package

Ground Rules:

  • This discussion is only about Use-Window extension (helper to focus a window) and the Use-Window extension (helper to focus a window) package. If you have feedback for Chocolatey, please contact the Google Group.
  • This discussion will carry over multiple versions. If you have a comment about a particular version, please note that in your comments.
  • The maintainers of this Chocolatey Package will be notified about new comments that are posted to this Disqus thread, however, it is NOT a guarantee that you will get a response. If you do not hear back from the maintainers after posting a message below, please follow up by using the link on the left side of this page or follow this link to contact maintainers. If you still hear nothing back, please follow the package triage process.
  • Tell us what you love about the package or Use-Window extension (helper to focus a window), or tell us what needs improvement.
  • Share your experiences with the package, or extra configuration or gotchas that you've found.
  • If you use a url, the comment will be flagged for moderation until you've been whitelisted. Disqus moderated comments are approved on a weekly schedule if not sooner. It could take between 1-5 days for your comment to show up.
comments powered by Disqus