UiaNodeFromFocus Function

Note  This function is deprecated. Client applications should use the Microsoft UI Automation COM interfaces instead.

Retrieves the UI Automation node for the user interface (UI) element that currently has input focus.

Syntax

HRESULT UiaNodeFromFocus(      
    UiaCacheRequest *pRequest,
    SAFEARRAY **ppRequestedData,
    BSTR *pTreeStructure
);

Parameters

• pRequest
  [in] The address of a UiaCacheRequest structure that contains information about data to be cached.
• ppRequestedData
  [out] The address of a variable that receives a pointer to a SAFEARRAY that contains the requested information. This parameter is passed uninitialized.
• pTreeStructure
  [out] The address of a variable that receives the description of the tree structure. This parameter is passed uninitialized. See Remarks.

Return Value

Returns S_OK if successful or an error value otherwise.

Remarks

The tree structure is described by a string where every character is either "p" or ")". The first character in the string always represents the root node. The string is NULL if no elements are returned by the function.

A "p" represents a node (UI Automation element). When one "p" directly follows another, the second node is a child of the first. A ")" represents a step back up the tree. For example, "pp)p" represents a node followed by two child nodes that are siblings of one another. In "pp))p", the last node is a sibling of the first one.

Function Information

Stock Implementation	uiautomationcore.dll
Custom Implementation	No
Header	uiautomationcoreapi.h
Import library	uiautomationcore.lib
Minimum operating systems	Windows XP