VioWrtCharStr: Difference between revisions
Created page with "==Description== Writes a character string to the display. ==Syntax== <PRE> #define INCL_VIO #include <os2.h> PCH CharStr; →String to be written.: ULONG Len..." |
No edit summary |
||
| Line 14: | Line 14: | ||
APIRET rc; /* Return code. */ | APIRET rc; /* Return code. */ | ||
rc = VioWrtCharStr(CharStr, Length, Row, Column, | rc = VioWrtCharStr(CharStr, Length, Row, Column, VioHandle); | ||
</PRE> | </PRE> | ||
| Line 30: | Line 29: | ||
; 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== | ||
| Line 36: | Line 35: | ||
VioWrtCharStr returns one of the following values: | VioWrtCharStr returns one of the following values: | ||
* 0 NO_ERROR | * 0 NO_ERROR | ||
* 355 ERROR_VIO_MODE | * 355 ERROR_VIO_MODE | ||
* 358 ERROR_VIO_ROW | * 358 ERROR_VIO_ROW | ||
* 359 ERROR_VIO_COL | * 359 ERROR_VIO_COL | ||
* 421 ERROR_VIO_INVALID_PARMS | * 421 ERROR_VIO_INVALID_PARMS | ||
* 436 ERROR_VIO_INVALID_HANDLE | * 436 ERROR_VIO_INVALID_HANDLE | ||
==Remarks== | ==Remarks== | ||
| Line 50: | Line 46: | ||
==Example Code== | ==Example Code== | ||
==Related Functions== | ==Related Functions== | ||
[[Category:The OS/2 API Project]] | [[Category:The OS/2 API Project]] | ||
Revision as of 20:09, 4 September 2016
Description
Writes a character string to the display.
Syntax
#define INCL_VIO #include <os2.h> PCH CharStr; /* String to be written. */ ULONG Length; /* Length of character string. */ ULONG Row; /* Starting row position. */ ULONG Column; /* Starting column position. */ HVIO VioHandle; /* VIO presentation-space handle. */ APIRET rc; /* Return code. */ rc = 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.