VioCreatePS: Difference between revisions
Created page with "==Description== Creates a VIO presentation space. ==Syntax== <PRE> #define INCL_VIO #include <os2.h> PHVIO phvps; →Pointer to the presentation-space handle.: UL..." |
mNo edit summary |
||
| Line 1: | Line 1: | ||
==Description== | ==Description== | ||
Creates a VIO presentation space. | Creates a VIO presentation space. | ||
==Syntax== | ==Syntax== | ||
<PRE> | <PRE> | ||
| Line 15: | Line 16: | ||
rc = VioCreatePS(phvps, Rows, Columns, Format, AttrBytes, hvps); | rc = VioCreatePS(phvps, Rows, Columns, Format, AttrBytes, hvps); | ||
</PRE> | </PRE> | ||
==Parameters== | ==Parameters== | ||
; | ; phvps (PHVIO) - output : Pointer to the presentation-space handle. | ||
The location where the newly created presentation-space handle is to be returned. | :The location where the newly created presentation-space handle is to be returned. | ||
; Rows (ULONG) - input : Number of rows. | ; Rows (ULONG) - input : Number of rows. | ||
:The number of rows in the presentation space. The maximum value allowed is 255. | |||
The number of rows in the presentation space. The maximum value allowed is 255. | |||
; Columns (ULONG) - input : Number of columns. | ; Columns (ULONG) - input : Number of columns. | ||
The number of columns in the presentation space. The maximum value allowed is 255. | :The number of columns in the presentation space. The maximum value allowed is 255. | ||
; Format (ULONG) - input : Format of the attributes | |||
; | :The attributes may be one of the following format types: | ||
The attributes may be one of the following format types: | ::1 VGA compatible | ||
::2 Unicode | |||
::3 MFI compatible | |||
; AttrBytes (ULONG) - input : Number of attribute bytes. | ; AttrBytes (ULONG) - input : Number of attribute bytes. | ||
This is used along with the format to select the attribute structure. This field has a value of 1, 2, or 3. | :This is used along with the format to select the attribute structure. This field has a value of 1, 2, or 3. | ||
; hvps (HVIO) - input : Reserved. Must be 0. | |||
; hvps (HVIO) - input : Reserved. Must be 0. | |||
==Return Code== | ==Return Code== | ||
| Line 44: | Line 38: | ||
VioCreatePS returns one of the following values: | VioCreatePS returns one of the following values: | ||
* 0 NO_ERROR | |||
* 421 ERROR_VIO_INVALID_PARMS | |||
* 436 ERROR_VIO_INVALID_HANDLE | |||
[[Category:Vio]] | |||
[[Category: | |||
Revision as of 22:35, 14 November 2016
Description
Creates a VIO presentation space.
Syntax
#define INCL_VIO #include <os2.h> PHVIO phvps; /* Pointer to the presentation-space handle. */ ULONG Rows; /* Number of rows. */ ULONG Columns; /* Number of columns. */ ULONG Format; /* Format of the attributes */ ULONG AttrBytes; /* Number of attribute bytes. */ HVIO hvps; /* Reserved. Must be 0. */ APIRET rc; /* Return code. */ rc = VioCreatePS(phvps, Rows, Columns, Format, AttrBytes, hvps);
Parameters
- phvps (PHVIO) - output
- Pointer to the presentation-space handle.
- The location where the newly created presentation-space handle is to be returned.
- Rows (ULONG) - input
- Number of rows.
- The number of rows in the presentation space. The maximum value allowed is 255.
- Columns (ULONG) - input
- Number of columns.
- The number of columns in the presentation space. The maximum value allowed is 255.
- Format (ULONG) - input
- Format of the attributes
- The attributes may be one of the following format types:
- 1 VGA compatible
- 2 Unicode
- 3 MFI compatible
- AttrBytes (ULONG) - input
- Number of attribute bytes.
- This is used along with the format to select the attribute structure. This field has a value of 1, 2, or 3.
- hvps (HVIO) - input
- Reserved. Must be 0.
Return Code
rc (APIRET) - returns
VioCreatePS returns one of the following values:
- 0 NO_ERROR
- 421 ERROR_VIO_INVALID_PARMS
- 436 ERROR_VIO_INVALID_HANDLE