Intermec 5055 Reference Guide
im_get_text
5-35
5
im_get_text
Purpose:
This function returns a rectangular section of text and its attributes from the 80 x 25
display. You specify a starting row and column and ending row and column.
display. You specify a starting row and column and ending row and column.
Syntax:
#include "im5055.h"
IM_STATUS im_get_text
IM_STATUS im_get_text
(IM_USHORT
start_col,
IM_USHORT
start_row,
IM_USHORT
end_col,
IM_USHORT
end_row,
IM_DISPLY_TEXT_S far
*text_array
);
IN Parameters:
start_col Starting column.
start_row Starting row.
end_col Ending column.
end_row Ending row.
OUT Parameters:
text_array Array of type display text large enough to receive the data represented by
the screen section.
the screen section.
text_array[n] Contains the attribute, where n is an odd number.
text_array[m] Contains the character, where m is an even number.
Return Value:
This function returns one of these codes:
IM_SUCCESS Successfully returned text and attributes.
IM_INVALID_END The ending location is outside the display. No data returned.
IM_INVALID_PAIR The end row/column combination is before the start
row/column combination. No data returned.
row/column combination. No data returned.
IM_INVALID_START The starting location is outside the display. No data returned.
Notes:
The retrieved data includes a one-byte attribute and a one-byte character. The order is
character, attribute, character, attribute, and so on. The buffer size must be larger than
(end_col – start_col + 1)
character, attribute, character, attribute, and so on. The buffer size must be larger than
(end_col – start_col + 1)
× (end_row – start_row+ 1) × 2.
See Also:
im_get_screen_char, im_put_text, im_putchar, im_puts