UFT Extensibility Agent library 1.3
LearnChildObjects Method
ITestable3 Interface : LearnChildObjects Method
For future use. Currently, always NULL.
An AddElements xml containing the branch of the object hierarchy starting at the the highest object within the Testing Agent's environment down to the specified object, and the tree from the specified object down to the leaves.
Description
Gets object IDs from root down to and including the specified object, and from the specified object to the bottom of the hierarchy.
Syntax
Visual Basic
Public Function LearnChildObjects( _
   ByVal objId As Variant, _
   ByVal filterXml As String, _
   ByRef learnChildrenXml As String, _
   ByRef externalParent As String _
) As Variant()
Parameters
objId
filterXml
For future use. Currently, always NULL.
learnChildrenXml
An AddElements xml containing the branch of the object hierarchy starting at the the highest object within the Testing Agent's environment down to the specified object, and the tree from the specified object down to the leaves.
externalParent
Return Type

A SAFEARRAY of object IDs.

Returns the list of object IDs from the root to the object, including the object itself, and the object IDs from the specified object down to the leaves. In the learnChildrenXml, set the index attribute of the Element describing each object to the index of the corresponding object in this array. The index of the first array element is zero.

If the Testing Agent does not support the learn functionality, implementation of this method is not required.

Remarks
To use this method, you must also implement the ISpyable Interface.
See Also