Functions/GenXdev.Windows/Get-Window.cs
|
// ################################################################################
// Part of PowerShell module : GenXdev.Windows // Original cmdlet filename : Get-Window.cs // Original author : René Vaessen / GenXdev // Version : 1.302.2025 // ################################################################################ // Copyright (c) René Vaessen / GenXdev // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. // ################################################################################ using System; using System.Diagnostics; using System.Linq; using System.Management.Automation; using WpfScreenHelper; namespace GenXdev.Windows { /// <summary> /// <para type="synopsis"> /// Gets window information for specified processes or window handles. /// </para> /// /// <para type="description"> /// Retrieves window information using process name, ID, or window handle. Returns /// WindowObj objects containing details about the main windows of matching processes. /// Supports wildcards when searching by process name. /// </para> /// /// <para type="description"> /// PARAMETERS /// </para> /// /// <para type="description"> /// -ProcessName <String><br/> /// Name of the process(es) to get window information for. Supports wildcards.<br/> /// - <b>Aliases</b>: Name<br/> /// - <b>Position</b>: 0<br/> /// - <b>Default</b>: (null)<br/> /// </para> /// /// <para type="description"> /// -ProcessId <Int32><br/> /// Process ID to get window information for. Must be a valid running process ID.<br/> /// - <b>Aliases</b>: Id, PID<br/> /// - <b>Position</b>: Named<br/> /// - <b>Default</b>: 0<br/> /// </para> /// /// <para type="description"> /// -WindowHandle <Int64><br/> /// Window handle to get information for. Must be a valid window handle number.<br/> /// - <b>Aliases</b>: Handle, hWnd<br/> /// - <b>Position</b>: Named<br/> /// - <b>Default</b>: 0<br/> /// </para> /// /// <example> /// <para>Get window information for all running Notepad instances</para> /// <para>This example retrieves window information for all processes named "notepad".</para> /// <code> /// Get-Window -ProcessName "notepad" /// </code> /// </example> /// /// <example> /// <para>Get window information for a specific process ID</para> /// <para>This example retrieves window information for the process with ID 1234.</para> /// <code> /// Get-Window -ProcessId 1234 /// </code> /// </example> /// /// <example> /// <para>Get window information for a specific window handle</para> /// <para>This example retrieves window information for the window with handle 45678.</para> /// <code> /// Get-Window -WindowHandle 45678 /// </code> /// </example> /// </summary> [Cmdlet(VerbsCommon.Get, "Window")] [OutputType(typeof(GenXdev.Helpers.WindowObj))] public class GetWindowCommand : PSGenXdevCmdlet { /// <summary> /// Name of the process(es) to get window information for /// </summary> [Parameter( Position = 0, ValueFromPipelineByPropertyName = true, HelpMessage = "Name of the process to get window information for" )] [ValidateNotNullOrEmpty] [Alias("Name")] [SupportsWildcards] public string ProcessName { get; set; } /// <summary> /// Process ID to get window information for /// </summary> [Parameter( ValueFromPipelineByPropertyName = true, HelpMessage = "ID of the process to get window information for" )] [ValidateNotNull] [Alias("Id", "PID")] public int ProcessId { get; set; } /// <summary> /// Window handle to get information for /// </summary> [Parameter( ValueFromPipelineByPropertyName = true, HelpMessage = "Window handle to get information for" )] [ValidateNotNull] [Alias("Handle", "hWnd")] public long WindowHandle { get; set; } /// <summary> /// Begin processing - initialization logic /// </summary> protected override void BeginProcessing() { WriteVerbose("Starting Get-Window with ParameterSet: " + this.ParameterSetName); } /// <summary> /// Process record - main cmdlet logic /// </summary> protected override void ProcessRecord() { // Diagnostic: Print all screens' DeviceName and WorkingArea try { var allScreens = WpfScreenHelper.Screen.AllScreens; foreach (var screen in allScreens) { var wa = screen.WorkingArea; var dev = screen.DeviceName; WriteVerbose($"Screen: {dev}, WorkingArea: X={wa.X} Y={wa.Y} W={wa.Width} H={wa.Height}"); } } catch { } // if window handle provided, get window info directly if (WindowHandle != 0) { WriteVerbose($"Getting window information for handle: {WindowHandle}"); var results = GenXdev.Helpers.WindowObj.GetMainWindow((IntPtr)WindowHandle); foreach (var result in results) { WriteObject(result); } return; } // if process id provided, get window info for that specific process if (ProcessId != 0) { WriteVerbose($"Getting window information for process ID: {ProcessId}"); var process = Process.GetProcessById(ProcessId); if (process != null && process.MainWindowHandle != IntPtr.Zero) { var results = GenXdev.Helpers.WindowObj.GetMainWindow(process); foreach (var result in results) { WriteObject(result); } } return; } // get window info for all processes matching the name pattern WriteVerbose($"Getting window information for process name: {ProcessName}"); string processNamePattern = ProcessName; if (!processNamePattern.Contains('*') && !processNamePattern.Contains('?')) { processNamePattern = $"{processNamePattern}*"; } // Use InvokeCommand to get processes with wildcard support var scriptBlock = ScriptBlock.Create("param($name) Microsoft.PowerShell.Management\\Get-Process $name -ErrorAction SilentlyContinue"); var processResults = scriptBlock.Invoke(processNamePattern); foreach (var processResult in processResults) { dynamic process = processResult.BaseObject; if (process.MainWindowHandle != IntPtr.Zero) { var results = GenXdev.Helpers.WindowObj.GetMainWindow(process); foreach (var result in results) { WriteObject(result); } } } } /// <summary> /// End processing - cleanup logic /// </summary> protected override void EndProcessing() { } } } |