VioWrtNCell (FAPI)

From EDM2
Jump to: navigation, search
Att.gif Legacy Function Warning
It is recommended to use a newer replacement for this function.
Replacement: VioWrtNCell
Remarks: This page list the older version of the function for reference.

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

Syntax

VioWrtNCell (Cell, Times, Row, Column, VioHandle) 

Parameters

Cell (PBYTE) - input 
Address of the character-attribute(s) cell (2 or 4 bytes) to be written.
Times (USHORT) - input 
Number of times to write the cell.
Row (USHORT) - input 
Starting cursor row.
Column (USHORT) - input 
Starting cursor column.
VioHandle (HVIO) - input 
This must be zero unless the caller is a Presentation Manager application, in which case it must be the value returned by VioGetPs.

Return Code

rc (USHORT) - return

Return code descriptions are:

  • 0 NO_ERROR
  • 355 ERROR_VIO_MODE
  • 358 ERROR_VIO_ROW
  • 359 ERROR_VIO_COL
  • 436 ERROR_VIO_INVALID_HANDLE
  • 465 ERROR_VIO_DETACHED

Remarks

If a repeated write gets to the end of the line and is not complete, the write continues at the beginning of the next line. If the write gets to the end of the screen, the write terminates.

PM Considerations

Write a cell (character-attribute) to the Advanced VIO presentation space a specified number of times. The caller must specify the starting location on the presentation space where the string is to be written.

Example Code

C Binding

#define INCL_VIO

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

PBYTE            Cell;          /* Cell to be written */
USHORT           Times;         /* Repeat count */
USHORT           Row;           /* Starting row position for output */
USHORT           Column;        /* Starting column position for output */
HVIO             VioHandle;     /* Video handle */

USHORT           rc;            /* return code */

MASM Binding

EXTRN  VioWrtNCell:FAR
INCL_VIO            EQU 1

PUSH@  OTHER   Cell          ;Cell to be written
PUSH   WORD    Times         ;Repeat count
PUSH   WORD    Row           ;Starting row position for output
PUSH   WORD    Column        ;Starting column position for output
PUSH   WORD    VioHandle     ;Video handle
CALL   VioWrtNCell

Returns WORD