ITextStrings::Item method (tom.h)

Gets an ITextRange2 object for a selected index in a string collection.

Syntax

HRESULT Item(
  [in]          long        Index,
  [out, retval] ITextRange2 **ppRange
);

Parameters

[in] Index

Type: long

The index of the string to retrieve. The default value is 1.

[out, retval] ppRange

Type: ITextRange2**

The object to receive the range.

Return value

Type: HRESULT

If the method succeeds, it returns NOERROR. Otherwise, it returns an HRESULT error code.

Remarks

The first string corresponds to Index = 1 and the last to Count which is given by ITextStrings_GetCount.

Requirements

Requirement Value
Minimum supported client Windows 8 [desktop apps only]
Minimum supported server Windows Server 2012 [desktop apps only]
Target Platform Windows
Header tom.h
DLL Msftedit.dll

See also

ITextStrings