Export (0) Print
Expand All

UiaFind Function

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

Retrieves one or more UI Automation nodes that match the search criteria.

Syntax


HRESULT UiaFind(          HUIANODE hnode,
    FindParams* pParams,
    UiaCacheRequest *pRequest,
    SAFEARRAY **ppRequestedData,
    SAFEARRAY **ppOffsets,
    SAFEARRAY **ppTreeStructures
);

Parameters

hnode
[in] The node to use as starting-point of the search.
pParams
[in] The address of a UiaFindParams structure that contains the search parameters.
pRequest
[in] The address of a UiaCacheRequest structure that specifies what information is to be cached.
ppRequestedData
[out] The address of a variable that recieves a pointer to a SAFEARRAY containing the requested data. This parameter is passed uninitialized. See Remarks.
ppOffsets
[out] The address of a variable that recieves a pointer to a SAFEARRAY containing the indexes to the requested data array for where the element subtree starts. This parameter is passed uninitialized.
ppTreeStructures
[out] The address of a variable that recieves a pointer to a SAFEARRAY containing 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

Community Additions

Show:
© 2014 Microsoft