Jump to content

VioWrtNCell: Difference between revisions

From EDM2
Created page with "==Description== Writes a cell (character-attribute pair) to the display a specified number of times. ==Syntax== <PRE> #define INCL_VIO #include <os2.h> PBYTE Cell; ..."
 
Ak120 (talk | contribs)
m Ak120 moved page OS2 API:CPI:VioWrtNCell to VioWrtNCell
(No difference)

Revision as of 19:23, 12 January 2017

Description

Writes a cell (character-attribute pair) to the display a specified number of times.

Syntax

#define INCL_VIO
#include <os2.h>

PBYTE     Cell;       /*  Attribute to be written. */
ULONG     Times;      /*  Repeat count. */
ULONG     Row;        /*  Starting row position. */
ULONG     Column;     /*  Starting column position. */
HVIO      VioHandle;  /*  VIO presentation-space handle. */
APIRET    rc;         /*  Return code. */

rc = VioWrtNCell(Cell, Times, Row, Column, VioHandle);

Parameters

Cell (PBYTE) - input
Attribute to be written.

The address of the character-attribute cell (2 or 4 bytes) to be written.

Times (ULONG) - input
Repeat count.

The number of times to write the attribute.

Row (ULONG) - input
Starting row position.
Column (ULONG) - input
Starting column position.
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

VioWrtNCell 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 repeated 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.

Example Code


Related Functions

  • [[OS2 API:CPI: