Share via

UiaNodeFromPoint Function

  • Article

Retrieves the UI Automation node for the element at the specified point.

Syntax

HRESULT UiaNodeFromPoint(      
    double x,
    double y,
    UiaCacheRequest *pRequest,
    SAFEARRAY **ppRequestedData,
    BSTR *ppTreeStructure
);

Parameters

  • x
    [in] The horizontal coordinate of the point.
  • y
    [in] The vertical coordinate of the point.
  • pRequest
    [in] The cache request for information from the client.
  • ppRequestedData
    [out] When this function returns, contains a pointer to the requested data. This parameter is passed uninitialized.
  • ppTreeStructure
    [out] When this function returns, contains a pointer to 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 element returned will be the closest element in the UI Automation tree structure that matches the specified criteria.

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