Edit

Share via

interop::GetWindowIdFromWindow function (microsoft.ui.interop.h)

  • Article

Gets the WindowId that corresponds to the specified window handle (HWND), if the hwnd argument is valid.

Note

The microsoft.ui.interop.h header has a dependency on microsoft.ui.h, which is not shipped as part of the Windows App SDK. You can run the MIDL compiler (midl.exe) on Microsoft.UI.idl in order to generate microsoft.ui.h. Or just use the functions in the winrt/Microsoft.ui.interop.h header instead.

C#. For C# desktop application developers, the interop functions in this header are wrapped by the methods of the Microsoft.UI.Win32Interop class.

Syntax

HRESULT GetWindowIdFromWindow(
  HWND                           hwnd,
  ::ABI::Microsoft::UI::WindowId *windowId
) noexcept;

Parameters

hwnd

Type: HWND

The handle of the window for which to get the WindowId.

windowId

Type: WindowId

The identifier that corresponds to hwnd, if hwnd is valid. Otherwise, null.

Return value

Type: HRESULT

Returns S_OK if the function succeeds. Otherwise, returns a value that indicates the error.

Requirements

Requirement Value
Minimum supported client Windows 10, version 1809 (with Windows App SDK 1.0 or later)
Header microsoft.ui.interop.h

See also

Manage app windows