KeyView 24.3

# VAPIM_SETHILITE

Highlights a region of text.

## Syntax

    #include <kvvapi.h>
    SendMessage(hWndVAPI, VAPIM_SETHILITE,
               (WPARAM) (int) cbTextToHilite,
               (LPARAM) (long) lLogicalAddress );

## Arguments

Argument | Description
--- | ---
`hWndVAPI` | The handle of VAPI window.
`cbTextToHilite` | An integer that is the number of bytes to highlight.
`lLogicalAddress` | A long integer that is the logical address from which to start highlighting.

## Returns

`SendMessage()` returns non-zero on success; or zero on error.

## Discussion

- This message should be sent to Viewing when a `VAPINM_TEXTBUFFER` is received, and before processing for that message has returned control to Viewing. When the `SendMessage( hWnd, VAPINM_TEXTBUFFER, ..)` returns, it is assumed that any highlights have been added to the buffer. There is no limit to the number of highlights that can be added.

- For spreadsheets, this message can also fail if the page containing the entire text region—that is, containing the last address in the text region—is not completely indexed.

Copyright 2016-2024 Open Text
Version 24.3 | Last updated June 2024

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: IDOL KeyView 24.3

Topic Title: VAPIM_SETHILITE