VioWrtNChar: Difference between revisions
Created page with "==Description== Writes a character to the display a specified number of times. ==Syntax== <PRE> #define INCL_VIO #include <os2.h> PCH Char; /* Character to be w..." |
mNo edit summary |
||
| (2 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
Writes a character to the display a specified number of times. | Writes a character to the display a specified number of times. | ||
==Syntax== | ==Syntax== | ||
VioWrtNChar(Char, Times, Row, Column, VioHandle); | |||
==Parameters== | ==Parameters== | ||
; Char (PCH) - input : Character to be written. | ;Char (PCH) - input : Character to be written. | ||
The address of the character to be written. | :The address of the character 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. | ||
;Column (ULONG) - input : Starting column position. | |||
; Row (ULONG) - input : Starting row 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. | |||
; 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== | ==Return Code== | ||
;rc (APIRET) - returns:VioWrtNChar returns one of the following values: | |||
* 0 NO_ERROR | |||
VioWrtNChar returns one of the following values: | *355 ERROR_VIO_MODE | ||
*358 ERROR_VIO_ROW | |||
* 0 | *359 ERROR_VIO_COL | ||
* 355 | *421 ERROR_VIO_INVALID_PARMS | ||
* 358 | *436 ERROR_VIO_INVALID_HANDLE | ||
* 359 | |||
* 421 | |||
* 436 | |||
==Remarks== | ==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. | 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. | ||
[[Category: | [[Category:Vio]] | ||
Latest revision as of 19:04, 14 September 2019
Writes a character to the display a specified number of times.
Syntax
VioWrtNChar(Char, Times, Row, Column, VioHandle);
Parameters
- Char (PCH) - input
- Character to be written.
- The address of the character 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
- VioWrtNChar 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.