VioWrtCharStrAtt: Difference between revisions
mNo edit summary |
mNo edit summary |
||
| Line 1: | Line 1: | ||
Writes a character string with repeated attributes to the display. | Writes a character string with repeated attributes to the display. | ||
==Syntax== | ==Syntax== | ||
| Line 5: | Line 5: | ||
==Parameters== | ==Parameters== | ||
;CharStr (PCH) - input : String to be written. | ;CharStr (PCH) - input: String to be written. | ||
:Address of the character string to be written. | :Address of the character string to be written. | ||
;Length (ULONG) - input : Length, in bytes, of the character string. | ;Length (ULONG) - input: Length, in bytes, of the character string. | ||
;Row (ULONG) - input : Starting row position. | ;Row (ULONG) - input: Starting row position. | ||
;Column (ULONG) - input : | ;Column (ULONG) - input: Starting column position. | ||
;Attr (PBYTE) - input : | ;Attr (PBYTE) - input: Attribute to be replicated. | ||
:Address of the attributes (1 or 3 bytes) to be used in the display buffer for each character of the string written. | :Address of the attributes (1 or 3 bytes) to be used in the display buffer for each character of the string written. | ||
;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:VioWrtCharStrAtt returns one of the following values: | |||
VioWrtCharStrAtt 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== | ||
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. | 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. | ||
[[Category:Vio]] | [[Category:Vio]] | ||
Latest revision as of 22:03, 1 January 2020
Writes a character string with repeated attributes to the display.
Syntax
VioWrtCharStrAtt (CharStr, Length, Row, Column, Attr, VioHandle)
Parameters
- CharStr (PCH) - input
- String to be written.
- Address of the character string to be written.
- Length (ULONG) - input
- Length, in bytes, of the character string.
- Row (ULONG) - input
- Starting row position.
- Column (ULONG) - input
- Starting column position.
- Attr (PBYTE) - input
- Attribute to be replicated.
- Address of the attributes (1 or 3 bytes) to be used in the display buffer for each character of the string written.
- 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
- VioWrtCharStrAtt 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.