Difference between revisions of "VioWrtCharStr"
From EDM2
m |
|||
| (3 intermediate revisions by one user not shown) | |||
| Line 1: | Line 1: | ||
| − | |||
Writes a character string to the display. | Writes a character string to the display. | ||
==Syntax== | ==Syntax== | ||
| − | + | VioWrtCharStr (CharStr, Length, Row, Column, VioHandle) | |
| − | + | ||
| − | + | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
==Parameters== | ==Parameters== | ||
| − | ; | + | ;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 of character string. | |
| − | ; Length (ULONG) - input : Length of character string. | + | :Length, in bytes, of the character string. |
| − | Length, in bytes, of the character string. | + | ;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:VioWrtCharStr returns one of the following values: | |
| − | + | * 0 NO_ERROR | |
| − | VioWrtCharStr returns one of the following values: | + | * 355 ERROR_VIO_MODE |
| − | * 0 | + | * 358 ERROR_VIO_ROW |
| − | * 355 | + | * 359 ERROR_VIO_COL |
| − | * 358 | + | * 421 ERROR_VIO_INVALID_PARMS |
| − | * 359 | + | * 436 ERROR_VIO_INVALID_HANDLE |
| − | * 421 | + | |
| − | * 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: | + | [[Category:Vio]] |
Latest revision as of 03:22, 26 February 2019
Writes a character string to the display.
Contents
Syntax
VioWrtCharStr (CharStr, Length, Row, Column, VioHandle)
Parameters
- CharStr (PCH) - input
- String to be written.
- Address of the character string to be written.
- Length (ULONG) - input
- Length of character string.
- Length, in bytes, of the character string.
- 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
- VioWrtCharStr 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.
