InputLightDismissAction.GetForWindowId(WindowId) Method

Definition

Retrieves the InputLightDismissAction object for the specified window.

public:
 static InputLightDismissAction ^ GetForWindowId(WindowId windowId);
 static InputLightDismissAction GetForWindowId(WindowId const& windowId);
public static InputLightDismissAction GetForWindowId(WindowId windowId);
function getForWindowId(windowId)
Public Shared Function GetForWindowId (windowId As WindowId) As InputLightDismissAction

Parameters

windowId
WindowId

The window identifier.

Returns

The InputLightDismissAction object for the specified window. Otherwise, null.

Remarks

GetForWindowId only supports top-level windows on the same thread as the caller.

If windowId is invalid, is owned by a different thread than the calling thread, or is a child window, GetForWindowId returns null.

Otherwise, GetForWindowId returns a previously created InputLightDismissAction associated with the Window ID or a newly created InputLightDismissAction associated with the Window ID. Calling GetForWindowId multiple times will return the same object each time.

In all cases there can only be a single InputLightDismissAction associated with a particular Window ID.

Applies to

See also