Share via

UiaGetUpdatedCache Function

  • Article

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

Updates the cache of property values and control patterns.

Syntax

HRESULT UiaGetUpdatedCache(      
    HUIANODE hnode,
    UiaCacheRequest *pRequest,
    NormalizeState normalizeState,
    UiaCondition *pNormalizeCondition,
    SAFEARRAY **ppRequestedData,
    BSTR **ppTreeStructure
);

Parameters

  • hnode
    [in] The element that updated information is being requested for.
  • pRequest
    [in] The address of a UiaCacheRequest structure that specifies the cached information to update.
  • normalizeState
    [in] A value from the NormalizeState enumerated type specifying the type of normalization.
  • pNormalizeCondition
    [in] The address of a UiaCondition structure that specifies a condition against which the information can be normalized, if normalizeState is NormalizeState_Custom.
  • ppRequestedData
    [out] The address of a variable that recieves a pointer to a SAFEARRAY that contains the requested data. This parameter is passed uninitialized. See Remarks.
  • ppTreeStructure
    [out] The address of a variable that receives 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 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