IXRTextBlock::GetHighlights (Windows Embedded CE 6.0)

1/6/2010

This method retrieves a value that specifies a set of characters to be highlighted.

Syntax

virtual HRESULT STDMETHODCALLTYPE GetHighlights(
    WCHAR* *pHighlights
) = 0;

Parameters

• pHighlights
  [out] Pointer to a string that contains highlight indices that specify a set of characters to be highlighted.

Return Value

Returns an HRESULT that indicates success or failure.

Remarks

The value in pHighlights represents highlight indices that are used to specify the substring in the text to highlight. It contains short integers in pairs that indicate where the current text highlights are positioned. Pairs are ordered as {start position}, {length}. For example, if the content in the text block is "hello world" and the highlight indices are [0,4], the content "hello world" would be displayed on-screen with the substring "hello" displayed in highlights.

.NET Framework Equivalent

None.

Requirements

See Also

Reference

IXRTextBlock
IXRTextBlock::SetHighlights