VIOCOLORREG: Difference between revisions

Latest revision as of 14:22, 24 May 2017

VIO colour register

Type

USHORT  cb
USHORT  type
USHORT  firstcolorreg
USHORT  numcolorregs
PCH     colorregaddr

C Declaration Method

typedef struct

Fields

cb

Length of the structure in bytes, including length. The maximum valid value is 12.

type

Request type = 3, get colour registers.

Request type 3 for colour registers.

firstcolorreg

First colour register.

The first colour register to get in the colour register sequence. It must be specified in the range 0 through 255. The colour registers are returned in sequential order.

numcolorregs

Number of colour registers to get.

The number of colour registers to get; must be specified in the range 1 through 256.

colorregaddr

Area where the colour registers are returned.

The far address of a data area where the colour registers are returned. The size of the data area must be three bytes times the number of colour registers to get. The format of each entry returned is as follows:

Byte 1 Red value

Byte 2 Green value

Byte 3 Blue value

@@ Line 1: / Line 1: @@
-== VIOCOLORREG ==
+VIO colour register
- VIO color register.
 === Type ===
+  [[USHORT]]  cb
-  [[OS2 API:DataType:USHORT|USHORT]]  cb
+  USHORT  type
-  [[OS2 API:DataType:USHORT|USHORT]]  type
+  USHORT  firstcolorreg
-  [[OS2 API:DataType:USHORT|USHORT]]  firstcolorreg
+  USHORT  numcolorregs
-  [[OS2 API:DataType:USHORT|USHORT]]  numcolorregs
+  PCH     colorregaddr
-  [[OS2 API:DataType:PCH|PCH]]     colorregaddr
 ==== C Declaration Method ====
 typedef struct
 === Fields ===
+;cb:Length of the structure in bytes, including length. The maximum valid value is 12.
- cb             Length of the structure in bytes, including length. The maximum
+;type:Request type = 3, get colour registers.
-                valid value is 12.
+:Request type 3 for colour registers.
+;firstcolorreg:First colour register.
- type           Request type = 3, get color registers.
+:The first colour register to get in the colour register sequence. It must be specified in the range 0 through 255. The colour registers are returned in sequential order.
-                Request type 3 for color registers.
+;numcolorregs:Number of colour registers to get.
+:The number of colour registers to get; must be specified in the range 1 through 256.
- firstcolorreg  First color register.
+;colorregaddr:Area where the colour registers are returned.
-                The first color register to get in the color register sequence.
+:The far address of a data area where the colour registers are returned. The size of the data area must be three bytes times the number of colour registers to get. The format of each entry returned is as follows:
-                It must be specified in the range 0 through 255. The color
+::Byte 1  Red value
-                registers are returned in sequential order.
+::Byte 2  Green value
+::Byte 3  Blue value
- numcolorregs   Number of color registers to get.
-                The number of color registers to get; must be specified in the
-                range 1 through 256.
- colorregaddr   Area where the color registers are returned.
-                The far address of a data area where the color registers are
-                returned. The size of the data area must be three bytes times
-                the number of color registers to get. The format of each entry
-                returned is as follows:
-                Byte 1  Red value
+[[Category:Data type]]
-                Byte 2  Green value
-                Byte 3  Blue value