Jump to content

DCBINFO: Difference between revisions

From EDM2
mNo edit summary
Ak120 (talk | contribs)
No edit summary
Line 1: Line 1:
== DCBINFO ==
== DCBINFO ==
Device control block information data structure.
Device control block information data structure.


=== Type ===  
=== Type ===
 
  [[OS2 API:DataType:USHORT|USHORT]]  usWriteTimeout
  [[OS2 API:DataType:USHORT|USHORT]]  usWriteTimeout
  [[OS2 API:DataType:USHORT|USHORT]]  usReadTimeout
  [[OS2 API:DataType:USHORT|USHORT]]  usReadTimeout
Line 16: Line 14:


==== C Declaration Method ====
==== C Declaration Method ====
typedef struct
typedef struct


=== Fields ===
=== Fields ===
;usWriteTimeout
:Time period used for Write Timeout processing. Specifies the time period used for Write Timeout processing. See Note 8 of ASYNC_SETDCBINFO. The value is in .01 second units based on zero (where 0 = .01 seconds).


usWriteTimeout        Time period used for Write Timeout processing.
;usReadTimeout
                      Specifies the time period used for Write Timeout processing.
:Time period used for Read Timeout processing. Specifies the time period used for Read Timeout processing. See Note 9 of ASYNC_SETDCBINFO. The value is in .01 second units based on zero (where 0 =.01 seconds).
                      See Note 8 of ASYNC_SETDCBINFO.
                      The value is in .01 second units based on zero (where 0 = .01 seconds).
usReadTimeout        Time period used for Read Timeout processing.
                      Specifies the time period used for Read Timeout processing.
                      See Note 9 of ASYNC_SETDCBINFO.
                      The value is in .01 second units based on zero (where 0 =.01 seconds).
   
   
fbCtlHndShake         HandShake Control flag.
;fbCtlHndShake
                      Has the following bits:
:HandShake Control flag. Has the following bits:
 
::Bits 0-1 - DTR Control mode. Has the following:
                      Bits 0-1     DTR Control mode. Has the following:  
:::Bit 1  Bit 0  Description
                                    Bit 1  Bit 0  Description  
:::0      0      Disable
                                    0      0      Disable  
:::0      1      Enable
                                    0      1      Enable  
:::1      0      Input handshaking
                                    1      0      Input handshaking  
:::1      1      Invalid input. Results in a general failure error.
                                    1      1      Invalid input. Results in a general failure error.  
::Bit 2 - Reserved. Must be 0.
                      Bit 2         Reserved. Must be 0.  
::Bit 3 - Enable output handshaking using CTS
                      Bit 3         Enable output handshaking using CTS  
::Bit 4 - Enable output handshaking using DSR
                      Bit 4         Enable output handshaking using DSR  
::Bit 5 - Enable output handshaking using DCD
                      Bit 5         Enable output handshaking using DCD  
::Bit 6 - Enable input sensitivity using DSR
                      Bit 6         Enable input sensitivity using DSR  
::Bit 7 - Reserved. Must be 0.
                      Bit 7         Reserved. Must be 0.  
    
    
fbFlowReplace         Flow Control flag.
;fbFlowReplace
                      Has the following bits:
:Flow Control flag. Has the following bits:
::Bit 0    Enable Automatic Transmit Flow Control (XON/XOFF)
::Bit 1    Enable Automatic Receive Flow Control (XON/XOFF)
::Bit 2    Enable error replacement character
::Bit 3    Enable null stripping (remove null bytes)
::Bit 4    Enable break replacement character
::Bit 5    Automatic Receive Flow Control:
:::0 =    Normal
:::1 =    Full-Duplex
::Bits 6-7  RTS Control mode. Has the following:
:::Bit 7  Bit 6  Description
:::0      0      Disable
:::0      1      Enable
:::1      0      Input handshaking
:::1      1      Toggling on transmit


                      Bit 0    Enable Automatic Transmit Flow Control (XON/XOFF)
;fbTimeout
                      Bit 1     Enable Automatic Receive Flow Control (XON/XOFF)
:Timeout flag. Has the following bits:
                      Bit 2     Enable error replacement character
::Bit 0    Enable Write Infinite Timeout processing
                      Bit 3     Enable null stripping (remove null bytes)
::Bits 1-2  Read Timeout processing. Has the following:
                      Bit 4     Enable break replacement character
:::Bit 2 Bit 1  Description
                      Bit 5    Automatic Receive Flow Control:  
:::0      1      Normal Read Timeout processing
                                0 =    Normal
:::1      0      Wait-For-Something, Read Timeout processing
                                1 =    Full-Duplex
:::1      1      No-Wait, Read Timeout processing
                      Bits 6-7 RTS Control mode. Has the following:  
::Bits 3-4  Extended Hardware Buffering. Has the following:
                                Bit 7 Bit 6 Description  
:::Bit 4 Bit 3  Description
                                0      0      Disable
:::0      0      Not supported
                                0      1      Enable
:::0      1      Extended Hardware Buffering Disabled
                                1      0      Input handshaking
:::1      0     Extended Hardware Buffering Enabled
                                1      1      Toggling on transmit
:::1      1     Automatic Protocol Override
::Bits 5-Receive Trigger Level. Has the following:
:::Bit 6 Bit 5 Description
:::0      0      1 character
:::0      1      4 characters
:::1      0      8 characters
:::1      1      14 characters
::Bit 7    Transmit Buffer Load Count
:::0 = 1 character
:::1 = 16 characters
:See ASYNC_SETDCBINFO for field definitions.
    
    
fbTimeout            Timeout flag. Has the following bits:
;bErrorReplacementChar
:Error Replacement Character. Value in the range 00h-FFh. See note 5 of SYNC_SETDCBINFO


                      Bit 0    Enable Write Infinite Timeout processing
;bBreakReplacementChar
                      Bits 1-2  Read Timeout processing. Has the following:
:Break Replacement Character. Value in the range 00h-FFh. See note 7 of ASYNC_SETDCBINFO
                                Bit 2  Bit 1  Description
                                0      1      Normal Read Timeout processing
                                1      0      Wait-For-Something, Read Timeout processing                 
                                1      1      No-Wait, Read Timeout processing
 
                      Bits 3-4  Extended Hardware Buffering.
                                Has the following:
                                Bit 4  Bit 3  Description
                                0      0      Not supported
                                0      1      Extended Hardware Buffering
                                              Disabled
                                1      0      Extended Hardware Buffering
                                              Enabled
                                1      1      Automatic Protocol Override
 
                      Bits 5-6  Receive Trigger Level. Has the following:
                                Bit 6  Bit 5  Description
                                0      0      1 character
                                0      1      4 characters
                                1      0      8 characters
                                1      1      14 characters
                      Bit 7    Transmit Buffer Load Count
                                0 = 1 character
                                1 = 16 characters
                      See ASYNC_SETDCBINFO for field definitions.
 
bErrorReplacementChar Error Replacement Character.
                      Value in the range 00h-FFh. See note 5 of SYNC_SETDCBINFO
   
   
bBreakReplacementChar Break Replacement Character.
;bXONChar
                      Value in the range 00h-FFh. See note 7 of ASYNC_SETDCBINFO
:Character XON. Value in the range 00h-FFh. See note 2 of ASYNC_SETDCBINFO
bXONChar              Character XON.
                      Value in the range 00h-FFh. See note 2 of ASYNC_SETDCBINFO
 
bXOFFChar            Character XOFF.
                      Value in the range 00h-FFh. See note 2 of ASYNC_SETDCBINFO
 
[[OS2_API | Back to OS/2 API]]


;bXOFFChar
:Character XOFF. Value in the range 00h-FFh. See note 2 of ASYNC_SETDCBINFO


[[Category:The OS/2 API Project]]
[[Category:Data type]]

Revision as of 22:41, 8 October 2016

DCBINFO

Device control block information data structure.

Type

USHORT  usWriteTimeout
USHORT  usReadTimeout
BYTE    fbCtlHndShake
BYTE    fbFlowReplace
BYTE    fbTimeout
BYTE    bErrorReplacementChar
BYTE    bBreakReplacementChar
BYTE    bXONChar
BYTE    bXOFFChar

C Declaration Method

typedef struct

Fields

usWriteTimeout
Time period used for Write Timeout processing. Specifies the time period used for Write Timeout processing. See Note 8 of ASYNC_SETDCBINFO. The value is in .01 second units based on zero (where 0 = .01 seconds).
usReadTimeout
Time period used for Read Timeout processing. Specifies the time period used for Read Timeout processing. See Note 9 of ASYNC_SETDCBINFO. The value is in .01 second units based on zero (where 0 =.01 seconds).
fbCtlHndShake
HandShake Control flag. Has the following bits:
Bits 0-1 - DTR Control mode. Has the following:
Bit 1 Bit 0 Description
0 0 Disable
0 1 Enable
1 0 Input handshaking
1 1 Invalid input. Results in a general failure error.
Bit 2 - Reserved. Must be 0.
Bit 3 - Enable output handshaking using CTS
Bit 4 - Enable output handshaking using DSR
Bit 5 - Enable output handshaking using DCD
Bit 6 - Enable input sensitivity using DSR
Bit 7 - Reserved. Must be 0.
fbFlowReplace
Flow Control flag. Has the following bits:
Bit 0 Enable Automatic Transmit Flow Control (XON/XOFF)
Bit 1 Enable Automatic Receive Flow Control (XON/XOFF)
Bit 2 Enable error replacement character
Bit 3 Enable null stripping (remove null bytes)
Bit 4 Enable break replacement character
Bit 5 Automatic Receive Flow Control:
0 = Normal
1 = Full-Duplex
Bits 6-7 RTS Control mode. Has the following:
Bit 7 Bit 6 Description
0 0 Disable
0 1 Enable
1 0 Input handshaking
1 1 Toggling on transmit
fbTimeout
Timeout flag. Has the following bits:
Bit 0 Enable Write Infinite Timeout processing
Bits 1-2 Read Timeout processing. Has the following:
Bit 2 Bit 1 Description
0 1 Normal Read Timeout processing
1 0 Wait-For-Something, Read Timeout processing
1 1 No-Wait, Read Timeout processing
Bits 3-4 Extended Hardware Buffering. Has the following:
Bit 4 Bit 3 Description
0 0 Not supported
0 1 Extended Hardware Buffering Disabled
1 0 Extended Hardware Buffering Enabled
1 1 Automatic Protocol Override
Bits 5-6 Receive Trigger Level. Has the following:
Bit 6 Bit 5 Description
0 0 1 character
0 1 4 characters
1 0 8 characters
1 1 14 characters
Bit 7 Transmit Buffer Load Count
0 = 1 character
1 = 16 characters
See ASYNC_SETDCBINFO for field definitions.
bErrorReplacementChar
Error Replacement Character. Value in the range 00h-FFh. See note 5 of SYNC_SETDCBINFO
bBreakReplacementChar
Break Replacement Character. Value in the range 00h-FFh. See note 7 of ASYNC_SETDCBINFO
bXONChar
Character XON. Value in the range 00h-FFh. See note 2 of ASYNC_SETDCBINFO
bXOFFChar
Character XOFF. Value in the range 00h-FFh. See note 2 of ASYNC_SETDCBINFO