VioReadCellStr

Description

Reads a string of character-attribute pairs (cells) from the screen, starting at the specified location.

Syntax

#define INCL_VIO
#include <os2.h>

PCH       CellStr;    /*  Cell string buffer. */
PULONG    Length;     /*  Length of cell string buffer. */
ULONG     Row;        /*  Starting row location. */
ULONG     Column;     /*  Starting column location. */
HVIO      VioHandle;  /*  Vio presentation-space handle. */
APIRET    rc;         /*  Return code. */

rc = VioReadCellStr(CellStr, Length, Row,
       Column, VioHandle);

Parameters

CellStr (PCH) - output

Cell string buffer.

Address of the buffer where the cell string is returned.

Length (PULONG) - in/out

Length of cell string buffer.

Address of the buffer length in bytes. Length must take into account that each character-attribute entry in the buffer is 2 or 4 bytes. If the length of the buffer is not sufficient, the last entry is not complete.

Row (ULONG) - input

Starting row location.

Starting row of the field to read, where 0 is the top row.

Column (ULONG) - input

Starting column location.

Starting column of the field to read, where 0 is the leftmost column.

VioHandle (HVIO) - input

Vio presentation-space handle.

This must be 0, unless the caller is a Presentation Manager application; in this case it must be the value returned by VioCreatePS.

Return Code

rc (APIRET) - returns

VioReadCellStr returns one of the following values:

• 0 NO_ERROR
• 355 ERROR_VIO_MODE
• 358 ERROR_VIO_ROW
• 359 ERROR_VIO_COL
• 421 ERROR_VIO_INVALID_PARMS
• 436 ERROR_VIO_INVALID_HANDLE

Remarks

If a string read comes to the end of the line and is not complete, it continues at the beginning of the next line. If the read comes to the end of the screen and is not complete, it terminates and the length is set to the length of the buffer that was filled.

Related Functions

• [[OS2 API:CPI: