ASYNC GETLINECTRL: Difference between revisions

Revision as of 08:26, 12 May 2020

This function returns the line characteristics (data bits, parity, stop bits, break).

Category: IOCTL_ASYNC (01h)
Function: ASYNC_GETLINECTRL (62h)

Parameter Packet Format

None. Packet pointer must be NULL.

Data Packet Format

Field	Length	C Datatype
Data Bits	BYTE	BYTE
Parity	BYTE	BYTE
Stop Bits	BYTE	BYTE
Transmitting Break	BYTE	BYTE

Related C Data Structure: The LINECONTROL data structure can be used by C programmers.; To include this data structure in your file, make sure INCL_DOSDEVIOCTL is defined before you include OS2.H.

Data Bits: See ASYNC_SETLINECTRL.
Parity: See ASYNC_SETLINECTRL.
Stop Bits: See ASYNC_SETLINECTRL.
Transmitting Break: 0 not currently transmitting break; 1 currently transmitting break

Returns

If the call is made with an invalid Parameter Packet value, a general failure error is reported and valid information is not returned in the Data Packet.

Remarks

If a general failure error is not returned, the physical device driver returns the line characteristics as defined.

@@ Line 1: / Line 1: @@
-This function returns the line characteristics (data bits, parity, stop bits, break).
+{{DISPLAYTITLE:ASYNC_GETLINECTRL}}
+This function returns the line characteristics (data bits, parity, stop bits, break).
-; Category: IOCTL_ASYNC (01h)
+;Category: IOCTL_ASYNC (01h)
-; Function: ASYNC_GETLINECTRL (62h)
+;Function: ASYNC_GETLINECTRL (62h)
 ==Parameter Packet Format==
 None. Packet pointer must be NULL.
 ==Data Packet Format==
+{|class="wikitable"
+!Field||Length||C Datatype
+|-
+|Data Bits||BYTE||BYTE
+|-
+|Parity||BYTE||BYTE
+|-
+|Stop Bits||BYTE||BYTE
+|-
+|Transmitting Break||BYTE||BYTE
+|}
-<pre>
+;Related C Data Structure:The LINECONTROL data structure can be used by C programmers.
-┌──────────────────────────────────────────────┐
+:To include this data structure in your file, make sure INCL_DOSDEVIOCTL is defined before you include OS2.H.
-│Field                  Length     C Datatype  │
-├──────────────────────────────────────────────┤
-│Data Bits              BYTE       BYTE        │
-├──────────────────────────────────────────────┤
-│Parity                 BYTE       BYTE        │
-├──────────────────────────────────────────────┤
-│Stop Bits              BYTE       BYTE        │
-├──────────────────────────────────────────────┤
-│Transmitting Break     BYTE       BYTE        │
-└──────────────────────────────────────────────┘
-</pre>
-;Related C Data Structure
+;Data Bits:See [[ASYNC_SETLINECTRL]].
+;Parity:See ASYNC_SETLINECTRL.
-The LINECONTROL data structure can be used by C programmers.
+;Stop Bits:See ASYNC_SETLINECTRL.
+;Transmitting Break:0 not currently transmitting break
-To include this data structure in your file, make sure INCL_DOSDEVIOCTL is defined before you include OS2.H.
+:1 currently transmitting break
-;Data Bits
-See ASYNC_SETLINECTRL.
-;Parity
-See ASYNC_SETLINECTRL.
-;Stop Bits
-:See ASYNC_SETLINECTRL.
-;Transmitting Break
-::0 not currently transmitting break
-::1 currently transmitting break
 ==Returns==
 If the call is made with an invalid Parameter Packet value, a general failure error is reported and valid information is not returned in the Data Packet.
 ==Remarks==
 If a general failure error is not returned, the physical device driver returns the line characteristics as defined.
 [[Category:IOCtl Commands]]
-{{DISPLAYTITLE:ASYNC_GETLINECTRL (62h)}}