windows c++ 获取串口列表

前言

最近开发一个软件需要连接串口外设，产品经理觉得手动选择串口号进行连接这样的操作实在太蠢了，要实现自动连接。这在Linux下很容易实现，在Windows下用C#读取注册表以前也实现过，本以为不会遇到问题，没想到网上搜到的代码都是同一个版本，不能直接运行，不知道是系统的原因还是VS版本的原因。

下面提供一个win10 x86/x64 VS2019能直接运行的程序代码

源码

直接上能够运行的代码，再说调试过程

#include "string.h"
#include "stdio.h"
#include <vector>  
#include <string>  
#include <atlbase.h>

char* wideCharToMultiByte(wchar_t* pWCStrKey)
{
    //第一次调用确认转换后单字节字符串的长度，用于开辟空间
    int pSize = WideCharToMultiByte(CP_OEMCP, 0, pWCStrKey, wcslen(pWCStrKey), NULL, 0, NULL, NULL);
    char* pCStrKey = new char[pSize + 1];
    //第二次调用将双字节字符串转换成单字节字符串
    WideCharToMultiByte(CP_OEMCP, 0, pWCStrKey, wcslen(pWCStrKey), pCStrKey, pSize, NULL, NULL);
    pCStrKey[pSize] = '\0';
    return pCStrKey;

    //如果想要转换成string，直接赋值即可
    //string pKey = pCStrKey;
}

std::vector<std::string> getComPort()
{
    HKEY hKey;
    wchar_t portName[256], w_commName[256];
    std::vector<std::string> comName;
    //打开串口注册表对应的键值  
	if (ERROR_SUCCESS == ::RegOpenKeyEx(HKEY_LOCAL_MACHINE, _T("Hardware\\DeviceMap\\SerialComm"), NULL, KEY_READ, &hKey))
    {
        int i = 0;
        int mm = 0;
        DWORD  dwLong, dwSize;
        while (TRUE)
        {
            dwLong = dwSize = sizeof(portName);
            //枚举串口
            if (ERROR_NO_MORE_ITEMS == ::RegEnumValue(hKey, i, portName, &dwLong, NULL, NULL, (PUCHAR)w_commName, &dwSize))
            {
                break;
            }
            char* commName = wideCharToMultiByte(w_commName);
            comName.push_back(commName);
            delete[] commName;
            i++;
        }
        //关闭注册表
        RegCloseKey(hKey);
    }
    else
    {
        //MessageBox(NULL, "您的计算机的注册表上没有HKEY_LOCAL_MACHINE:Hardware\\DeviceMap\\SerialComm项", "警告", MB_OK);
    }
    //返回串口号
    return comName;
}

调试过程

首先看了几篇博客，发现大家用的都是同一份代码

//得到所有的串口号
vector<string> cnComm::getComPort()
{
	HKEY hKey;	
	char portName[256], commName[256];
	//打开串口注册表对应的键值  
	if (ERROR_SUCCESS == ::RegOpenKeyEx(HKEY_LOCAL_MACHINE, "Hardware\\DeviceMap\\SerialComm", NULL, KEY_READ, &hKey))
	{
		int i = 0;
		int mm = 0;
		DWORD  dwLong, dwSize;
		while (TRUE)
		{
			dwLong = dwSize = sizeof(portName);
			//枚举串口
			if (ERROR_NO_MORE_ITEMS == ::RegEnumValue(hKey, i, portName, &dwLong, NULL, NULL, (PUCHAR)commName, &dwSize))   
			{
				break;
			}
			comName.push_back(commName);
			i++;
		}
		//关闭注册表
		RegCloseKey(hKey);
	}
	else
	{
		MessageBox(NULL,"您的计算机的注册表上没有HKEY_LOCAL_MACHINE:Hardware\\DeviceMap\\SerialComm项","警告",MB_OK);
	}
	//返回串口号
	return comName;
}

没有多想，直接复制粘贴编译，一下报了4处错误

• MessageBox未定义，先改为printf("您的计算机的注册表上没有HKEY_LOCAL_MACHINE:Hardware\\DeviceMap\\SerialComm项\n");
• comName未定义，应该是忘了定义，补上std::vector<std::string> comName;
• 还有两个类型转换的错误，先强制转换一下，LPCWSTR("Hardware\\DeviceMap\\SerialComm")、LPWSTR(portName)

所有编译错误消失，运行

无法进入if判断，单独运行::RegOpenKeyEx(HKEY_LOCAL_MACHINE, "Hardware\\DeviceMap\\SerialComm", NULL, KEY_READ, &hKey)查看返回值为2——ERROR_FILE_NOT_FOUND，无法找到这个文件夹，但是手动查看注册便却能找到此项。

又测试了其他的注册表，发现注册表中其他项也无法打开。经过一番折腾后，看到一个这样的写法LPCTSTR data_set = _T("Software\\Chicony\\Lenovo1");，测试之后问题解决，可以打开注册表了。原来是因为windows注册表使用unicode编码格式，英文字符串在编译时使用ascii码格式，导致错误，需要使用_T()声明为Unicode编码格式。

继续调试，输出串口列表中所有串口名称

怎么都只有首字母，赶紧debug下断点查看变量值

每两个字母之间都有一个0x00，再看RegEnumValue函数定义，需要的参数是LPWSTR类型，又是编码格式的原因，LPWSTR是wchar_t字符串，wchar_t是宽字节字符，占2字节，所以使用char字符串进行读取时，会出现很多0x00。修改portName和commName定义为wchar_t portName[256], commName[256];后，再次查看变量，可以正常读取了。

但是这时comName.push_back(commName);又报错了，因为wchar_t宽字节数组无法push_back到string中，需要先将wchar_t数组转换为char数组，可以使用MultiByteToWideChar();、WideCharToMultiByte();这两个函数进行转换，如下

#include <windows.h>
#include <string>
 
//不要忘记在使用完wchar_t*后delete[]释放内存
wchar_t *multiByteToWideChar(const string& pKey)
{
    char* pCStrKey = pKey.c_str();
    //第一次调用返回转换后的字符串长度，用于确认为wchar_t*开辟多大的内存空间
    int pSize = MultiByteToWideChar(CP_OEMCP, 0, pCStrKey, strlen(pCStrKey) + 1, NULL, 0); 
    wchar_t *pWCStrKey = new wchar_t[pSize];
    //第二次调用将单字节字符串转换成双字节字符串
    MultiByteToWideChar(CP_OEMCP, 0, pCStrKey, strlen(pCStrKey) + 1, pWCStrKey, pSize);
    return pWCStrKey;
}

#include <windows.h>
#include <string>
 
//不要忘记使用完char*后delete[]释放内存
char* wideCharToMultiByte(wchar_t* pWCStrKey)
{
    //第一次调用确认转换后单字节字符串的长度，用于开辟空间
    int pSize = WideCharToMultiByte(CP_OEMCP, 0, pWCStrKey, wcslen(pWCStrKey), NULL, 0, NULL, NULL);
    char* pCStrKey = new char[pSize+1];
    //第二次调用将双字节字符串转换成单字节字符串
    WideCharToMultiByte(CP_OEMCP, 0, pWCStrKey, wcslen(pWCStrKey), pCStrKey, pSize, NULL, NULL);
    pCStrKey[pSize] = '\0';
    return pCStrKey;
 
    //如果想要转换成string，直接赋值即可
    //string pKey = pCStrKey;
}

加入转换函数后，再次调整代码，即为文章开头的代码，能够正常运行

参考文章

https://blog.csdn.net/jacken123456/article/details/81783905
https://www.cnblogs.com/MrYuan/p/10656233.html
http://www.bathome.net/thread-30783-1-1.html
https://www.cnblogs.com/lightspeedsmallson/p/4928100.html
https://blog.csdn.net/qq_27278957/article/details/77991751
https://blog.csdn.net/xwh012510/article/details/86235698
https://blog.csdn.net/doutd_y/article/details/81745901
https://blog.csdn.net/qq1841370452/article/details/81697313