2.2.2.4.10.1.10 LineOrder

The LineOrder packet contains a line.

0	1	2	3	4	5	6	7	8	9	1 0	1	2	3	4	5	6	7	8	9	2 0	1	2	3	4	5	6	7	8	9	3 0	1
pControlFlags								OrderType (optional)								FieldBytes
Bounds (13 bytes, optional)
...
...
...								BackMode																nXStart (optional)
...								nYStart (optional)																nXEnd (optional)
...								nYEnd (optional)																BackColor (optional)
...																ROP2 (optional)								PenStyle (optional)
PenWidth (optional)								PenColor (optional)

pControlFlags (1 byte): MUST be set to the value OE2_CF_STANDARD_ENC from the OE2 Control Flags enumeration. If the order differs in type from the last order that was sent, this field contains the bitwise AND of the value OE2_CF_TYPE_CHANGE. If the bounding rectangle has changed since the last order of the same type, this field contains the bitwise AND of the value OE2_CF_BOUNDS. If the coordinates of the bounding rectangle are specified as deltas from the last bounding rectangle that was used, this field contains the bitwise AND of the value OE2_CF_DELTACOORDS.

OrderType (1 byte): If the order differs in type from the last, this field MUST contain the value OE2_LINETO_ORDER from the Order Types enumeration. If the order is the same type as the last, this field is not present.

FieldBytes (2 bytes): A 16-bit field, with each bit indicating which of the fields that follow is present. A bit set to 1 indicates that the field is present and its value has changed since the same order type was last sent.

0	1	2	3	4	5	6	7	8	9	1 0	1	2	3	4	5
A	B	C	D	E	F	G	H	I	0	0	0	0	0	0	0

Where the bits are defined as:

Value	Description
A	The nXStart value is present.
B	The nYStart value is present.
C	The nXEnd value is present.
D	The nYEnd value is present.
E	The BackColor value is present.
F	The ROP2 value is present.
G	The PenStyle value is present.
H	The PenWidth value is present.
I	The PenColor value is present.

Bits that are marked with 0 MUST be set to zero.

Bounds (13 bytes): A byte array of a BoundsData structure. This field is present only if the pControlFlags field contains the bitwise AND of the value OE2_CF_BOUNDS from the OE2 Control Flags enumeration.

BackMode (2 bytes): One of the BackMode values that are specified in section 2.2.1.2.1 MUST be present to specify how the foreground and background SHOULD be mixed.

nXStart (2 bytes): This value MUST be present if the corresponding bit from FieldBytes is set. This represents the x-coordinate within the window for the start of the line.

nYStart (2 bytes): This value MUST be present if the corresponding bit from FieldBytes is set. This represents the y-coordinate within the window for the start of the line.

nXEnd (2 bytes): This value MUST be present if the corresponding bit from FieldBytes is set. This represents the x-coordinate within the window for the end of the line.

nYEnd (2 bytes): This value MUST be present if the corresponding bit from FieldBytes is set. This represents the y-coordinate within the window for the end of the line.

BackColor (3 bytes): This value MUST be present if the corresponding bit from FieldBytes is set. This field represents the background color value that is specified by a byte array of a TSHR_COLOR structure.

ROP2 (1 byte): MUST be present if the corresponding bit from FieldBytes is set. This represents the ROP2 values that are specified in section 2.2.1.2.5.

PenStyle (1 byte): This value MUST be present if the corresponding bit from FieldBytes is set. This represents the PenStyle values that are specified in section 2.2.1.2.4.

PenWidth (1 byte): This value MUST be present if the corresponding bit from FieldBytes is set. This represents the width, in pixels, of the pen.

PenColor (3 bytes): This value MUST be present if the corresponding bit from FieldBytes is set. This represents the color value of the pen that is specified by a byte array of a TSHR_COLOR structure.