📄 dcb.cs
字号:
/*=====================================================================
File: DCB.cs
Summary: Provides a class that wraps the native Win32 DCB structure.
---------------------------------------------------------------------
This file is part of the Microsoft .NET Framework SDK Code Samples.
Copyright (C) Microsoft Corporation. All rights reserved.
This source code is intended only as a supplement to Microsoft
Development Tools and/or on-line documentation. See these other
materials for detailed information regarding Microsoft code samples.
THIS CODE AND INFORMATION ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY
KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A
PARTICULAR PURPOSE.
=====================================================================*/
using System;
using System.Text;
using System.IO;
using System.Runtime.InteropServices;
namespace NiceTracker.Serial
{
//
// The Win32 DCB structure is implemented below in a C# class.
//
[StructLayout(LayoutKind.Sequential)]
public class DCB
{
//
// Note the layout of the Win32 DCB structure in native code and that
// it contains bitfields. I use a UInt32 to contain the bit field
// and then use properties to expose the individual bits at bools or
// appropriate flags (as in the case of fDtrControl and fRtsControl).
//
//
// typedef struct _DCB {
// DWORD DCBlength;
// DWORD BaudRate;
// DWORD fBinary: 1;
// DWORD fParity: 1;
// DWORD fOutxCtsFlow:1;
// DWORD fOutxDsrFlow:1;
// DWORD fDtrControl:2;
// #define DTR_CONTROL_DISABLE 0x00
// #define DTR_CONTROL_ENABLE 0x01
// #define DTR_CONTROL_HANDSHAKE 0x02
// DWORD fDsrSensitivity:1;
// DWORD fTXContinueOnXoff:1;
// DWORD fOutX: 1;
// DWORD fInX: 1;
// DWORD fErrorChar: 1;
// DWORD fNull: 1;
// DWORD fRtsControl:2;
// #define RTS_CONTROL_DISABLE 0x00
// #define RTS_CONTROL_ENABLE 0x01
// #define RTS_CONTROL_HANDSHAKE 0x02
// #define RTS_CONTROL_TOGGLE 0x03
// DWORD fAbortOnError:1;
// DWORD fDummy2:17;
// WORD wReserved;
// WORD XonLim;
// WORD XoffLim;
// BYTE ByteSize;
// BYTE Parity;
// BYTE StopBits;
// char XonChar;
// char XoffChar;
// char ErrorChar;
// char EofChar;
// char EvtChar;
// WORD wReserved1;
// } DCB;
//
//
// Enumeration for fDtrControl bit field. Underlying type only needs
// to be a byte since we only have 2-bits of information.
//
public enum DtrControlFlags : byte
{
Disable = 0,
Enable =1 ,
Handshake = 2
}
//
// Enumeration for fRtsControl bit field. Underlying type only needs
// to be a byte since we only have 2-bits of information.
//
public enum RtsControlFlags : byte
{
Disable = 0,
Enable = 1,
Handshake = 2,
Toggle = 3
}
public DCB()
{
//
// Initialize the length of the structure. Marshal.SizeOf returns
// the size of the unmanaged object (basically the object that
// gets marshalled).
//
this.DCBlength = (uint)Marshal.SizeOf(this);
}
private UInt32 DCBlength;
public UInt32 BaudRate;
internal UInt32 Control;
internal UInt16 wReserved;
public UInt16 XonLim;
public UInt16 XoffLim;
public byte ByteSize;
public byte Parity;
public byte StopBits;
public sbyte XonChar;
public sbyte XoffChar;
public sbyte ErrorChar;
public sbyte EofChar;
public sbyte EvtChar;
internal UInt16 wReserved1;
//
// We need to have reserved fields to preserve the size of the
// underlying structure to match the Win32 structure when it is
// marshaled. Use these fields to suppress compiler warnings.
//
internal void _SuppressCompilerWarnings()
{
wReserved +=0;
wReserved1 +=0;
}
// Helper constants for manipulating the bit fields.
private readonly UInt32 fBinaryMask = 0x00000001;
private readonly Int32 fBinaryShift = 0;
private readonly UInt32 fParityMask = 0x00000002;
private readonly Int32 fParityShift = 1;
private readonly UInt32 fOutxCtsFlowMask = 0x00000004;
private readonly Int32 fOutxCtsFlowShift = 2;
private readonly UInt32 fOutxDsrFlowMask = 0x00000008;
private readonly Int32 fOutxDsrFlowShift = 3;
private readonly UInt32 fDtrControlMask = 0x00000030;
private readonly Int32 fDtrControlShift = 4;
private readonly UInt32 fDsrSensitivityMask = 0x00000040;
private readonly Int32 fDsrSensitivityShift = 6;
private readonly UInt32 fTXContinueOnXoffMask = 0x00000080;
private readonly Int32 fTXContinueOnXoffShift = 7;
private readonly UInt32 fOutXMask = 0x00000100;
private readonly Int32 fOutXShift = 8;
private readonly UInt32 fInXMask = 0x00000200;
private readonly Int32 fInXShift = 9;
private readonly UInt32 fErrorCharMask = 0x00000400;
private readonly Int32 fErrorCharShift = 10;
private readonly UInt32 fNullMask = 0x00000800;
private readonly Int32 fNullShift = 11;
private readonly UInt32 fRtsControlMask = 0x00003000;
private readonly Int32 fRtsControlShift = 12;
private readonly UInt32 fAbortOnErrorMask = 0x00004000;
private readonly Int32 fAbortOnErrorShift = 14;
public bool fBinary
{
get { return ((Control & fBinaryMask) != 0); }
set { Control |= (Convert.ToUInt32(value) << fBinaryShift); }
}
public bool fParity
{
get { return ((Control & fParityMask) != 0); }
set { Control |= (Convert.ToUInt32(value) << fParityShift); }
}
public bool fOutxCtsFlow
{
get { return ((Control & fOutxCtsFlowMask) != 0); }
set { Control |= (Convert.ToUInt32(value) << fOutxCtsFlowShift); }
}
public bool fOutxDsrFlow
{
get { return ((Control & fOutxDsrFlowMask) != 0); }
set { Control |= (Convert.ToUInt32(value) << fOutxDsrFlowShift); }
}
public DtrControlFlags fDtrControl
{
get { return (DtrControlFlags)((Control & fDtrControlMask) >> fDtrControlShift); }
set { Control |= (Convert.ToUInt32(value) << fDtrControlShift); }
}
public bool fDsrSensitivity
{
get { return ((Control & fDsrSensitivityMask) != 0); }
set { Control |= (Convert.ToUInt32(value) << fDsrSensitivityShift); }
}
public bool fTXContinueOnXoff
{
get { return ((Control & fTXContinueOnXoffMask) != 0); }
set { Control |= (Convert.ToUInt32(value) << fTXContinueOnXoffShift); }
}
public bool fOutX
{
get { return ((Control & fOutXMask) != 0); }
set { Control |= (Convert.ToUInt32(value) << fOutXShift); }
}
public bool fInX
{
get { return ((Control & fInXMask) != 0); }
set { Control |= (Convert.ToUInt32(value) << fInXShift); }
}
public bool fErrorChar
{
get { return ((Control & fErrorCharMask) != 0); }
set { Control |= (Convert.ToUInt32(value) << fErrorCharShift); }
}
public bool fNull
{
get { return ((Control & fNullMask) != 0); }
set { Control |= (Convert.ToUInt32(value) << fNullShift); }
}
public RtsControlFlags fRtsControl
{
get { return (RtsControlFlags)((Control & fRtsControlMask) >> fRtsControlShift); }
set { Control |= (Convert.ToUInt32(value) << fRtsControlShift); }
}
public bool fAbortOnError
{
get { return ((Control & fAbortOnErrorMask) != 0); }
set { Control |= (Convert.ToUInt32(value) << fAbortOnErrorShift); }
}
//
// Method to dump the DCB to take a look and help debug issues.
//
public override String ToString()
{
StringBuilder sb = new StringBuilder();
sb.Append("DCB:\r\n");
sb.AppendFormat(null, " BaudRate: {0}\r\n", BaudRate);
sb.AppendFormat(null, " Control: 0x{0:x}\r\n", Control);
sb.AppendFormat(null, " fBinary: {0}\r\n", fBinary);
sb.AppendFormat(null, " fParity: {0}\r\n", fParity);
sb.AppendFormat(null, " fOutxCtsFlow: {0}\r\n", fOutxCtsFlow);
sb.AppendFormat(null, " fOutxDsrFlow: {0}\r\n", fOutxDsrFlow);
sb.AppendFormat(null, " fDtrControl: {0}\r\n", fDtrControl);
sb.AppendFormat(null, " fDsrSensitivity: {0}\r\n", fDsrSensitivity);
sb.AppendFormat(null, " fTXContinueOnXoff: {0}\r\n", fTXContinueOnXoff);
sb.AppendFormat(null, " fOutX: {0}\r\n", fOutX);
sb.AppendFormat(null, " fInX: {0}\r\n", fInX);
sb.AppendFormat(null, " fNull: {0}\r\n", fNull);
sb.AppendFormat(null, " fRtsControl: {0}\r\n", fRtsControl);
sb.AppendFormat(null, " fAbortOnError: {0}\r\n", fAbortOnError);
sb.AppendFormat(null, " XonLim: {0}\r\n", XonLim);
sb.AppendFormat(null, " XoffLim: {0}\r\n", XoffLim);
sb.AppendFormat(null, " ByteSize: {0}\r\n", ByteSize);
sb.AppendFormat(null, " Parity: {0}\r\n", Parity);
sb.AppendFormat(null, " StopBits: {0}\r\n", StopBits);
sb.AppendFormat(null, " XonChar: {0}\r\n", XonChar);
sb.AppendFormat(null, " XoffChar: {0}\r\n", XoffChar);
sb.AppendFormat(null, " ErrorChar: {0}\r\n", ErrorChar);
sb.AppendFormat(null, " EofChar: {0}\r\n", EofChar);
sb.AppendFormat(null, " EvtChar: {0}\r\n", EvtChar);
return sb.ToString();
}
}
}
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -