TextPattern_get_DocumentRange
TOC
Collapse the table of content
Expand the table of content

TextPattern_get_DocumentRange function

Note  This function is deprecated. Client applications should use the Microsoft UI Automation Component Object Model (COM) interfaces instead.
 

Gets the text range for the entire document.

Syntax


HRESULT TextPattern_get_DocumentRange(
  _In_  HUIAPATTERNOBJECT hobj,
  _Out_ HUIATEXTRANGE     *pRetVal
);

Parameters

hobj [in]

Type: HUIAPATTERNOBJECT

A control pattern object.

pRetVal [out]

Type: HUIATEXTRANGE*

When this function returns, contains the text range spanning the entire document contents of the text container. This parameter is passed uninitialized.

Return value

Type: HRESULT

Returns S_OK if successful or an error value otherwise.

Requirements

Minimum supported client

Windows XP [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Header

UIAutomationCoreApi.h

Library

Uiautomationcore.lib

DLL

Uiautomationcore.dll

 

 

Show:
© 2016 Microsoft