Export (0) Print
Expand All

ITextRangeProvider::GetChildren method

Retrieves a collection of all embedded objects that fall within the text range.

Syntax


HRESULT GetChildren(
  [out, retval]  SAFEARRAY **pRetVal
);

Parameters

pRetVal [out, retval]

Type: SAFEARRAY**

Receives the address of an array of pointers to the IRawElementProviderSimple interfaces of all child objects that fall within the range. This parameter is passed uninitialized.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

Children that overlap with the text range but are not entirely enclosed by it will also be included in the collection.

The method returns a pointer to an empty collection if there are no child objects.

Requirements

Minimum supported client

Windows XP [desktop apps | Windows Store apps]

Minimum supported server

Windows Server 2003 [desktop apps | Windows Store apps]

Header

UIAutomationCore.h (include UIAutomation.h)

IDL

UIAutomationCore.idl

See also

Reference
ITextProvider
ITextRangeProvider
Conceptual
UI Automation Providers Overview
Best Practices for Using Safe Arrays

 

 

Community Additions

ADD
Show:
© 2014 Microsoft