Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

UiaNodeFromPoint function

Note  This function is deprecated. Client applications should use the Microsoft UI Automation Component Object Model (COM) interfaces instead.

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

Syntax


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

Parameters

x [in]

Type: double

The horizontal coordinate of the point.

y [in]

Type: double

The vertical coordinate of the point.

pRequest [in]

Type: UiaCacheRequest*

The address of a UiaCacheRequest structure that contains the cache request for information from the client.

ppRequestedData [out]

Type: SAFEARRAY**

The address of a variable that receives a pointer to a SAFEARRAY that contains the requested data. This parameter is passed uninitialized.

ppTreeStructure [out]

Type: BSTR*

The address of a variable that receives the description of the tree structure. This parameter is passed uninitialized. See Remarks.

Return value

Type: HRESULT

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.

Requirements

Minimum supported client

Windows XP [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Header

UIAutomationCoreApi.h

Library

Uiautomationcore.lib

DLL

Uiautomationcore.dll

 

 

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.