VioWrtCellStr (FAPI): Difference between revisions
No edit summary |
mNo edit summary |
||
| Line 1: | Line 1: | ||
This call writes a string of character-attribute pairs (cells) to the display. | |||
This call writes a string of character-attribute pairs (cells) to the display. | |||
==Syntax== | ==Syntax== | ||
| Line 16: | Line 12: | ||
==Return Code== | ==Return Code== | ||
;rc (USHORT) - return:Return code descriptions are: | |||
Return code descriptions are: | *0 NO_ERROR | ||
* 0 | *355 ERROR_VIO_MODE | ||
* 355 | *358 ERROR_VIO_ROW | ||
* 358 | *359 ERROR_VIO_COL | ||
* 359 | *436 ERROR_VIO_INVALID_HANDLE | ||
* 436 | *465 ERROR_VIO_DETACHED | ||
* 465 | |||
==Remarks== | ==Remarks== | ||
| Line 29: | Line 24: | ||
===PM Considerations=== | ===PM Considerations=== | ||
Write a character-attribute string to the Advanced VIO presentation space. The caller must specify the starting location on the presentation space where the string is to be written. | Write a character-attribute string to the Advanced VIO presentation space. The caller must specify the starting location on the presentation space where the string is to be written. | ||
== | |||
=== C | ==Bindings== | ||
===C=== | |||
<PRE> | <PRE> | ||
#define INCL_VIO | #define INCL_VIO | ||
| Line 37: | Line 33: | ||
USHORT rc = VioWrtCellStr(CellStr, Length, Row, Column, VioHandle); | USHORT rc = VioWrtCellStr(CellStr, Length, Row, Column, VioHandle); | ||
PCH | PCH CellStr; /* String to be written */ | ||
USHORT | USHORT Length; /* Length of string */ | ||
USHORT | USHORT Row; /* Starting row position for output */ | ||
USHORT | USHORT Column; /* Starting column position for output */ | ||
HVIO | HVIO VioHandle; /* Video handle */ | ||
USHORT | USHORT rc; /* return code */ | ||
</PRE> | </PRE> | ||
===MASM | ===MASM=== | ||
<PRE> | <PRE> | ||
EXTRN VioWrtCellStr:FAR | EXTRN VioWrtCellStr:FAR | ||
Latest revision as of 17:20, 28 February 2020
This call writes a string of character-attribute pairs (cells) to the display.
Syntax
VioWrtCellStr (CellStr, Length, Row, Column, VioHandle)
Parameters
- CellStr (PCH) - input
- Address of the string of character-attribute(s) cells to be written.
- Length (USHORT) - input
- Length, in bytes, of the string to be written. Each character-attribute(s) cell is 2 or 4 bytes.
- 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 string write gets to the end of the line and is not complete, the string 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 character-attribute string to the Advanced VIO presentation space. The caller must specify the starting location on the presentation space where the string is to be written.
Bindings
C
#define INCL_VIO USHORT rc = VioWrtCellStr(CellStr, Length, Row, Column, VioHandle); PCH CellStr; /* String to be written */ USHORT Length; /* Length of string */ USHORT Row; /* Starting row position for output */ USHORT Column; /* Starting column position for output */ HVIO VioHandle; /* Video handle */ USHORT rc; /* return code */
MASM
EXTRN VioWrtCellStr:FAR INCL_VIO EQU 1 PUSH@ OTHER CellStr ;String to be written PUSH WORD Length ;Length of string PUSH WORD Row ;Starting row position for output PUSH WORD Column ;Starting column position for output PUSH WORD VioHandle ;Video handle CALL VioWrtCellStr Returns WORD
Related Functions
- VioReadCellStr