VioWrtCellStr: Difference between revisions
mNo edit summary |
mNo edit summary |
||
| Line 1: | Line 1: | ||
Writes a string of character-attribute pairs (cells) to the display. | Writes a string of character-attribute pairs (cells) to the display. | ||
==Syntax== | ==Syntax== | ||
| Line 5: | Line 5: | ||
==Parameters== | ==Parameters== | ||
;CellStr (ULONG) - input : String to be written. | ;CellStr (ULONG) - input: String to be written. | ||
:Address of the string of character-attribute cells to be written. | :Address of the string of character-attribute cells to be written. | ||
;Length (ULONG) - input : Length of string. | ;Length (ULONG) - input: Length of string. | ||
:Length, in bytes, of the string to be written. Each character-attribute cell is 2 or 4 bytes. | :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. | ;Row (ULONG) - input: Starting row position for output. | ||
;Column (ULONG) - input : Starting column position for output. | ;Column (ULONG) - input: Starting column position for output. | ||
; 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:VioWrtCellStr returns one of the following values: | |||
VioWrtCellStr 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== | ||
Latest revision as of 21:11, 1 January 2020
Writes a string of character-attribute pairs (cells) to the display.
Syntax
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.