ITextRangeProvider::GetChildren Method

  • Article

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

Syntax

HRESULT GetChildren(      
    SAFEARRAY **pRetVal
);

Parameters

  • pRetVal
    [out, retval]  The address of a variable that receives a pointer to a SAFEARRAY that contains an array of pointers to the IRawElementProviderSimple interfaces of all child objects that fall within the range. This parameter is passed uninitialized.

Return Value

Returns S_OK if successful, or an error value otherwise.

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.

See Also

UI Automation Providers Overview, ITextProvider, Working with Safe Arrays