VAPIM_GETTEXT

Gets a text buffer from a specified range.

Syntax

#include <kvvapi.h>
SendMessage(hWndVAPI, VAPIM_GETTEXT, 0L,
           (LPARAM) (TPVAPIGetText*) lpGetText );

Arguments

Argument Description
hWndVAPI The handle of the VAPI window.
lpGetText A pointer to a TPVAPIGetText structure, which defines the text to get.

Returns

SendMessage() returns the number of BYTES it stored in the buffer; or -1 on error.

Discussion

  • Send this message to obtain a buffer of text from a specified range. It is assumed that the text buffer is large enough to hold the required number of bytes. The data is not null terminated.

  • This message does not wait for a logical address to become valid in the same way as VAPIM_POSITION (for non-spreadsheets). This message does not retrieve text across buffer boundaries.

  • For spreadsheets, this message also fails if the page containing the entire text buffer—that is, containing the last address in the text buffer—is not completely indexed.