VioWrtNCell: Difference between revisions
mNo edit summary |
mNo edit summary |
||
| Line 5: | Line 5: | ||
==Parameters== | ==Parameters== | ||
;Cell (PBYTE) - input : Attribute to be written. | ;Cell (PBYTE) - input: Attribute to be written. | ||
:The address of the character-attribute cell (2 or 4 bytes) to be written. | :The address of the character-attribute cell (2 or 4 bytes) to be written. | ||
;Times (ULONG) - input : Repeat count. | ;Times (ULONG) - input: Repeat count. | ||
:The number of times to write the attribute. | :The number of times to write the attribute. | ||
;Row (ULONG) - input : Starting row position. | ;Row (ULONG) - input: Starting row position. | ||
;Column (ULONG) - input : | ;Column (ULONG) - input: Starting column position. | ||
;VioHandle (HVIO) - input : VIO presentation-space handle. | ;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. | :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== | ==Return Code== | ||
;rc (APIRET) - returns:VioWrtNCell returns one of the following values: | |||
VioWrtNCell returns one of the following values: | *0 NO_ERROR | ||
* 0 | *355 ERROR_VIO_MODE | ||
* 355 | *358 ERROR_VIO_ROW | ||
* 358 | *359 ERROR_VIO_COL | ||
* 359 | *421 ERROR_VIO_INVALID_PARMS | ||
* 421 | *436 ERROR_VIO_INVALID_HANDLE | ||
* 436 | |||
==Remarks== | ==Remarks== | ||
Revision as of 16:42, 5 March 2020
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
- 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.