API串口通信实例.docx
《API串口通信实例.docx》由会员分享，可在线阅读，更多相关《API串口通信实例.docx（53页珍藏版）》请在冰豆网上搜索。
API串口通信实例
API串口通信实例
API函数不仅提供了打开和读写通讯端口的操作方法，还提供了名目繁多的函数以支持对串行通讯的各种操作。
常用函数及作用下：
函数名 作用
CreateFile 打开串口
GetCommState 检测串口设置
SetCommState 设置串口
BuilderCommDCB 用字符串中的值来填充设备控制块
GetCommTimeouts 检测通信超时设置
SetCommTimeouts 设置通信超时参数
SetCommMask 设定被监控事件
WaitCommEvent 等待被监控事件发生
WaitForMultipleObjects 等待多个被监测对象的结果
WriteFile 发送数据
ReadFile 接收数据
GetOverlappedResult 返回最后重叠（异步）操作结果
PurgeComm 清空串口缓冲区,退出所有相关操作
ClearCommError 更新串口状态结构体,并清除所有串口硬件错误
CloseHandle 关闭串行口
用WindowsAPI编写串口程序本身是有巨大优点的，因为控制能力会更强，效率也会更
高。
API编写串口，过程一般是这样的：
1、创建串口句柄，用CreateFile；
2、对串口的参数进行设置，其中比较重要的是波特率（BaudRate），数据宽度（BytesBits），奇偶校验（Parity），停止位（StopBits），当然，重要的还有端口号（Port）；
3、然后对串口进行相应的读写操作，这时候用到ReadFile和WriteFile函数；
4、 读写结束后，要关闭串口句柄，用CloseFile。
下面依次讲述各个步骤的过程。
第二节 创建串口句柄打开串口
从字面上去理解，大家也可以发现CreateFile实际上表明Windows是把串口当作一个文件来处理的，所以它也有文件那样的缓冲区、句柄、读写错误等，不同的是，这个文件名字只有固定的几个（一般为四个），而且始终存在（EXSITING），而且在调用CreateFile的时候请注意它的参数。
CreateFile函数原型如下：
HANDLECreateFile（LPCTSTRlpFileName,
DWORDdwDesiredAccess,
DWORDdwShareMode,
LPSECURITY_ATTRIBUTESlpSecurityAttributes,
DWORDdwCreationDisposition,
DWORDdwFlagsAndAttributes,
HANDLEhTemplateFile）;
lpFileName：
指向一个以NULL结束的字符串，该串指定了要创建、打开或截断的文件、管道、通信源、磁盘设备或控制台的名字。
当用CreateFile打开串口时，这个参数可用“COM1”指定串口1，用“COM2”指定串口2，依此类推。
dwDesireAccess：
指定对文件访问的类型，该参数可以为GENERIC_READ（指定对该文件的读访问权）或GENERIC_WRITE（指定该文件的写访问权）两个值之一或同时为为这两个值。
用ENERIC_READ|GENERIC_WRITE则指定可对串口进行读写;
dwShareMode：
指定此文件可以怎样被共享。
因为串行口不支持任何共享模式，所以dwShareMode必须设为０;
lpSecurityAttributes定义安全属性，一般不用，可设为NULL。
Win9x下该参数被忽略；
dwCreationDistribution定义文件创建方式，对串口必须设为OPEN_EXISTING，表示打开已经存在的文件；
dwFlagsAndAttributes为该文件指定定义文件属性和标志，这个程序中设为FILE_FLAG_OVERLAPPED，表示异步通信方式；
hTemplateFile指向一个模板文件的句柄，串口无模板可言，设为NULL。
在Windows9x下该参数必须为NULL。
串口被成功打开时，返回其句柄，否则返回INVALID_HANDLE_value（0XFFFFFFFF）。
上面说到了异步，那什么是异步呢？
异步是相对同步这个概念而言的。
异步，就是说，
在进行串口读写操作时，不用等到I/O操作完成后函数才返回，也就是说，异步可以更快得
响应用户操作；同步，相反，响应的I/O操作必须完成后函数才返回，否则阻塞线程。
对于
一些很简单的通讯程序来说，可以选择同步，这样可以省去很多错误检查，但是对于复杂一点的应用程序，异步是最佳选择。
实例1：
/****************** example1.cpp ******************************************/
/*lishaoan2009-06-29*****************************************************/
/*******************************************************/
#include
#include
#include
boolopenport（char*portname）//打开串口
{
HANDLEhComm;
hComm=CreateFile（portname,//串口号
GENERIC_READ|GENERIC_WRITE,//允许读写
0,//通讯设备必须以独占方式打开
0,//无安全属性
OPEN_EXISTING,//通讯设备已存在
FILE_FLAG_OVERLAPPED,//异步I/O
0）;//通讯设备不能用模板打开
if（hComm==INVALID_HANDLE_VALUE）
{
CloseHandle（hComm）;
returnFALSE;
}
else
returntrue;
}
void main（）
{
boolopen;
open=openport（"com2"）;
if（open）
printf（"opencomportsuccess"）;
system（"pause"）;
}
/**************************programend***************************************/
实例2：
/****************** example2.cpp ******************************************/
/*lishaoan2009-06-29*****************************************************/
/*******************************************************/
#include
#include
#include
boolopenport（char*portname）//打开串口
{
HANDLEhComm;
hComm=CreateFile（portname,//串口号
GENERIC_READ|GENERIC_WRITE,//允许读写
0,//通讯设备必须以独占方式打开
0,//无安全属性
OPEN_EXISTING,//通讯设备已存在
0,//同步I/O
0）;//通讯设备不能用模板打开
if（hComm==INVALID_HANDLE_VALUE）
{
CloseHandle（hComm）;
returnFALSE;
}
else
returntrue;
}
void main（）
{
boolopen;
open=openport（"com2"）;
if（open）
printf（"opencomportsuccess"）;
system（"pause"）;
}
/**************************programend***************************************/
第三节设置串口
在打开通信设备句柄后，常常需要对串行口进行一些初始化工作。
这需要通过一个DCB结构来进行。
DCB结构包含了诸如波特率、每个字符的数据位数、奇偶校验和停止位数等信息。
在查询或配置串口的属性时，都要用DCB结构来作为缓冲区。
第一次打开串口时，串口设置为系统默认值，函数GetCommState和SetCommState可用于检索和设定端口设置的DCB（设备控制块）结构，该结构中BaudRate、ByteSize、StopBits和Parity字段含有串口波特率、数据位数、停止位和奇偶校验控制等信息。
程序中用DCB进行串口设置时，应先调用API函数GetCommState，来获得串口的设置信息：
GetCommState（）
用途：
取得串口当前状态
原型：
BOOLGetCommState（HANDLEhFile,LPDCBlpDCB）;
参数说明：
-hFile：
串口句柄
-lpDCB：
设备控制块（DeviceControlBlock）结构地址。
此结构中含有和设备相关的参数。
此处是与串口相关的参数。
由于参数非常多，当需要设置串口参数时，通常是先取得串口的参数结构，修改部分参数后再将参数结构写入。
然后在需要设置的地方对dcb进行设置。
串口有很多的属性，上面也已经介绍了一些最重要的参数。
这里介绍数据结构DCB：
typedefstruct_DCB{//dcb
DWORDDCBlength; //DCB结构体大小
DWORDBaudRate; //波特率
DWORDfBinary:
1; //是否是二进制，一般设置为TRUE
DWORDfParity:
1;//是否进行奇偶校验
DWORDfOutxCtsFlow:
1;//CTS线上的硬件握手
DWORDfOutxDsrFlow:
1;//DSR线上的硬件握手
DWORDfDtrControl:
2;//DTR控制
DWORDfDsrSensitivity:
1;
DWORDfTXContinueOnXoff:
1;
DWORDfOutX:
1; //是否使用XON/XOFF协议
DWORDfInX:
1; //是否使用XON/XOFF协议
DWORDfErrorChar:
1; //发送错误协议
DWORDfNull:
1;
DWORDfRtsControl:
2;
DWORDfAbortOnError:
1;
DWORDfDummy2:
17;
WORDwReserved;
WORDXonLim; //设置在XON字符发送之前inbuf中允许的最少字节数
WORDXoffLim; //在发送XOFF字符之前outbuf中允许的最多字节数
BYTEByteSize;//数据宽度，一般为8，有时候为7
BYTEParity; //奇偶校验
BYTEStopBits; //停止位数
charXonChar; //设置表示XON字符的字符,一般是采用0x11这个数值
charXoffChar;//设置表示XOFF字符的字符,一般是采用0x13这个数值
charErrorChar;
charEofChar;
charEvtChar;
WORDwReserved1;
}DCB;
我们真正在串口编程中用到的数据成员没有几个，在此仅介绍少数的几个常用的参数：
DWORDBaudRate：
串口波特率
DWORDfParity：
为1的话激活奇偶校验检查
DWORDParity：
校验方式，值0~4分别对应无校验、奇校验、偶校验、校验置位、校验清零
DWORDByteSize：
一个字节的数据位个数，范围是5~8
DWORDStopBits：
停止位个数，0~2分别对应1位、1.5位、2位停止位
然后再末尾调用SetCommState就可以了，还是比较方便的。
这样可不必构造一个完整的DCB结构。
SetCommState（）
用途：
设置串口状态，包括常用的更改串口号、波特率、奇偶校验方式、数据位数等
原型：
BOOLSetCommState（HANDLEhFile,LPDCBlpDCB）;
参数说明：
-hFile:
串口句柄
-lpDCB：
设备控制块（DeviceControlBlock）结构地址。
要更改的串口参数包含在此结构中。
然后调用SetCommMask,用来指定程序接收特定的串口事件,调用SetupComm函数,设置串口缓冲区大小:
SetCommMask（）说明：
用途：
设置串口通信事件。
原型：
BOOLSetCommMask（HANDLEhFile,
DWORDdwEvtMask
）;
参数说明：
-hFile：
串口句柄
-dwEvtMask：
准备监视的串口事件掩码
该参数有如下信息掩码位值：
EV_BREAK:
收到BREAK信号
EV_CTS:
CTS（cleartosend）线路发生变化
EV_DSR:
DST（DataSetReady）线路发生变化
EV_ERR:
线路状态错误，包括了CE_FRAME\CE_OVERRUN\CE_RXPARITY3钟错误。
EV_RING:
检测到振铃信号。
EV_RLSD:
CD（CarrierDetect）线路信号发生变化。
EV_RXCHAR:
输入缓冲区中已收到数据。
EV_RXFLAG:
使用SetCommState（）函数设置的DCB结构中的等待字符已被传入输入缓冲区中。
EV_TXEMPTY:
输出缓冲区中的数据已被完全送出。
还有，串口因为是I/O操作，可能会产生错误，这时候需要用SetCommTimeouts（）设置超时限制，以避免阻塞现象。
设置超时设置需要一个结构体COMMTIMEOUTS。
SetCommTimeouts（）
BOOLSetCommTimeouts（hCommDev，lpctmo）；
Lpctmo指向包含新的超时参数的COMMTIMEOUTS结构。
COMMTIMEOUTS结构定义如下：
typedefstruct_COMMTIMEOUTS{
DWORDReadIntervalTimeout;
DWORDReadTotalTimeoutMultiplier;
DWORDReadTotalTimeoutconstant;
DWORDWriteTotalTimeoutMultiplier;
DWORDWriteTotalTimeoutconstant;
}COMMTIMEOUTS，LPCOMMTIMEOUTS;
ReadIntervalTimeout：
以毫秒为单位指定通信线上两个字符到达之间的最大时间。
在
ReadFile操作其间，收到第一个字符时开始计算时间。
若任意两个字符到达之间的间隔超过
这个最大值，ReadFile操作完成，返回缓冲数据。
0值表示不用间隔限时。
若该成员为
MAXDWORD，且ReadTotalTimeoutconstant和ReadTotalTimeoutMultiplier成员为零，则指
出读操作要立即返回已接收到的字符，即使未收到字符，读操作也要返回。
ReadTotalTimeoutMultiplier：
以毫秒为单位指定一个乘数，该乘数用来计算读操作的总限时时间。
每个读操作的总限时时间等于读操作所需的字节数与该值的乘积。
ReadTotalTimeoutConstant：
以毫秒为单位指定一个常数，用于计算读操作的总限时时间。
每个操作的总限时时间等于ReadTotalTimeoutMultiplier成员乘以读操作所需字节数再加上该值的和。
ReadTotalTimeoutMultiplier和ReadTotalTimeoutConstant成员的值为0表示读操作不使用限时时间。
WriteTotalTimeoutMultiplier和WriteTotalTimeoutconstant的意义和作用分别与
ReadTotalTimeoutMultiplier和ReadTotalTimeoutConstant相似，不再重复。
举例：
COMMTIMEOUTStimeouts;
timeouts.ReadIntervalTimeout=MAXDWORD;
timeouts.ReadTotalTimeoutConstant=0;
timeouts.ReadTotalTimeoutMultiplier=0;
timeouts.WriteTotalTimeoutConstant=50;
timeouts.WriteTotalTimeoutMultiplier=2000;
SetCommTimeouts（m_hCom,&timeouts）;
这里将ReadIntervalTimeout设置为最大字节数，.ReadTotalTimeoutConstant和
ReadTotalTimeoutMultiplier都设置为0，表示不设置读操作超时，也就是说读操作瞬间完
成，不进行等待。
调用PurgeComm函数可以终止正在进行的读写操作，该函数还会清除输入或输出缓冲区中的内容。
PurgeComm（）说明：
功能：
终止目前正在进行的读或写的动作
函数原型：
BOOLPurgeComm（
HANDLEhFile,//handleofcommunicationsresource
DWORDdwFlags//actiontoperform
）;
参数说明：
HANDLEhFile,//串口名称字符串
dwFlags共有四种flags:
PURGE_TXABORT:
终止目前正在进行的（背景）写入动作
PURGE_RXABORT:
终正目前正在进行的（背景）读取动作
PURGE_TXCLEAR:
flush写入的buffer
PURGE_TXCLEAR:
flush读取的buffer
实例3：
/****************** example3.cpp ******************************************/
/*lishaoan2009-06-29*****************************************************/
/*******************************************************/
#include
#include
#include
boolopenport（char*portname）//打开串口
{
HANDLEhComm;
hComm=CreateFile（portname,//串口号
GENERIC_READ|GENERIC_WRITE,//允许读写
0,//通讯设备必须以独占方式打开
0,//无安全属性
OPEN_EXISTING,//通讯设备已存在
0,//同步I/O
0）;//通讯设备不能用模板打开
if（hComm==INVALID_HANDLE_VALUE）
{
CloseHandle（hComm）;
returnFALSE;
}
else
returntrue;
}
boolsetupdcb（intrate_arg）//设置DCB
{
DCBdcb;
intrate=rate_arg;
memset（&dcb,0,sizeof（dcb））;
if（!
GetCommState（hComm,&dcb））//获取当前DCB配置
returnFALSE;
//setDCBtoconfiguretheserialport
dcb.DCBlength =sizeof（dcb）;
/*----------SerialPortConfig-------*/
dcb.BaudRate =rate;
dcb.Parity =NOPARITY;
dcb.fParity =0;
dcb.StopBits =ONESTOPBIT;
dcb.ByteSize =8;
dcb.fOutxCtsFlow =0;
dcb.fOutxDsrFlow =0;
dcb.fDtrControl =DTR_CONTROL_DISA
升级会员 