VioWrtCellStr

Description

Writes a string of character-attribute pairs (cells) to the display.

Syntax

#define INCL_VIO
#include <os2.h>

ULONG     CellStr;    /*  String to be written. */
ULONG     Length;     /*  Length of string. */
ULONG     Row;        /*  Starting row position for output. */
ULONG     Column;     /*  Starting column position for output. */
HVIO      VioHandle;  /*  VIO presentation-space handle. */
APIRET    rc;         /*  Return code. */

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

Parameters

CellStr (ULONG) - input

String to be written.

Address of the string of character-attribute cells to be written.

Length (ULONG) - input

Length of string.

Length, in bytes, of the string to be written. Each character-attribute cell is 2 or 4 bytes.

Row (ULONG) - input

Starting row position for output.

Column (ULONG) - input

Starting column position for output.

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

VioWrtCellStr 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 write gets to the end of the line and is not complete, it continues at the beginning of the next line. If the write gets to the end of the screen, it terminates.

Related Functions

• [[OS2 API:CPI: