UFT Extensibility Agent library 1.3
GetChildren Method
ITestable Interface : GetChildren Method

A unique identifier for the object across all active applications being tested in the same environment. The ID is generated at run-time by the testing agent. It is transitory and not recorded with the test. An ID can be a number, pointer value, hash key, HWND, database string, or any otherapplication-specific data.

If isExternalParent is true, the object ID is an XML string that conforms to the External Parent Schema.

If false, indicates that this object is defined by the testing agent. If true, the object is the external container of the application being tested. An example of an external parent is a web page displaying the test object.
The Filter xml that specifies items to include in the output. If the xml contains only the root element ( <Filter/> ), GetChildren returns all children.
Description
Returns the object IDs of the direct descendents of the specified object.
Syntax
Visual Basic
Public Function GetChildren( _
   ByVal objId As Variant, _
   ByVal isExternalParent As Boolean, _
   ByVal filterXml As String _
) As Variant()
Parameters
objId

A unique identifier for the object across all active applications being tested in the same environment. The ID is generated at run-time by the testing agent. It is transitory and not recorded with the test. An ID can be a number, pointer value, hash key, HWND, database string, or any otherapplication-specific data.

If isExternalParent is true, the object ID is an XML string that conforms to the External Parent Schema.

isExternalParent
If false, indicates that this object is defined by the testing agent. If true, the object is the external container of the application being tested. An example of an external parent is a web page displaying the test object.
filterXml
The Filter xml that specifies items to include in the output. If the xml contains only the root element ( <Filter/> ), GetChildren returns all children.
Return Type
A SAFEARRAY containing the objIDs of the children. If there are no children, returns NULL.
See Also