MainWindowHandle Property

Process.MainWindowHandle Property

 

Gets the window handle of the main window of the associated process.

Namespace:   System.Diagnostics
Assembly:  System (in System.dll)

public IntPtr MainWindowHandle { get; }

Property Value

Type: System.IntPtr

The system-generated window handle of the main window of the associated process.

Exception Condition
InvalidOperationException

The MainWindowHandle is not defined because the process has exited.

NotSupportedException

You are trying to access the MainWindowHandle property for a process that is running on a remote computer. This property is available only for processes that are running on the local computer.

PlatformNotSupportedException

The platform is Windows 98 or Windows Millennium Edition (Windows Me); set ProcessStartInfo.UseShellExecute to false to access this property on Windows 98 and Windows Me.

The main window is the window opened by the process that currently has the focus (the TopLevel form). You must use the Refresh method to refresh the Process object to get the current main window handle if it has changed. In general, because the window handle is cached, use Refresh beforehand to guarantee that you’ll retrieve the current handle.

You can get the MainWindowHandle property only for processes that are running on the local computer. The MainWindowHandle property is a value that uniquely identifies the window that is associated with the process.

A process has a main window associated with it only if the process has a graphical interface. If the associated process does not have a main window, the MainWindowHandle value is zero. The value is also zero for processes that have been hidden, that is, processes that are not visible in the taskbar. This can be the case for processes that appear as icons in the notification area, at the far right of the taskbar.

If you have just started a process and want to use its main window handle, consider using the WaitForInputIdle method to allow the process to finish starting, ensuring that the main window handle has been created. Otherwise, an exception will be thrown.

Win98WinMe

This property is not available on this platform if you started the process with ProcessStartInfo.UseShellExecute set to true.

LinkDemand

for full trust for the immediate caller. This member cannot be used by partially trusted code.

.NET Framework
Available since 1.1
Return to top
Show:
© 2016 Microsoft