Click here to Skip to main content
Click here to Skip to main content

Enumerating serial ports - W2K style.

, 20 Jul 2002
Rate this:
Please Sign up or sign in to vote.
Enumerating the serial ports using the SetupDi* API provided with Win2K and later
<!-- Download Links --> <!-- Add the rest of your HTML here -->

Introduction

You might think that determining which serial ports are present on a Windows PC would be an easy task. It seems like a reasonable enough thing for the OS to support. Unfortunately, there was no support for it at all (short of reading the registry yourself) before Win2K, and even then, the API is a bit cumbersome.

The attached serial port enumeration code first determines which operating system it is running under, and then runs the appropriate routine to enumerate the serial ports. In Win 9x (and Me) it uses the registry. In W2K and later it uses the SetupAPI that was included in that version of the WinSDK. It also has support for "brute force" enumeration of serial ports under NT4.

Unfortunately, I statically linked with setupapi.lib, so the provided executable won't actually run under 95 and nt4 (I didn't really need to support those OS's for my application.) This could be finagled by replacing the SetupDi* function calls with dynamic binding via LoadLibrary if needed.

To use the EnumSerial code, simply include EnumSerial.cpp and .h in your project, and link with setupapi.lib in the win32 sdk (this is under "additional dependencies" in the project link settings in Visual Studio).

All you have to do now is #include "EnumSerial.h" in your source code, allocate an empty CArray of SSerInfo structs, and make a call to EnumSerialPorts. It will populate your array with filled-out SSerInfo structs which contain the following information:

CString strDevPath;      // Device path for use with CreateFile()
CString strPortName;     // Simple name (i.e. COM1)
CString strFriendlyName; // Full name to be displayed to a user
BOOL bUsbDevice;         // Provided through a USB connection?
CString strPortDesc;     // friendly name without the COMx

Example

CArray<SSerInfo,SSerInfo&> asi;
EnumSerialPorts(asi,FALSE/*include all*/);

License

This article has no explicit license attached to it but may contain usage terms in the article text or the download files themselves. If in doubt please contact the author via the discussion board below.

A list of licenses authors might use can be found here

About the Author

Zach Gorman

United States United States
No Biography provided

Comments and Discussions

 
QuestionEnumSerial class Pinmemberalkam11-Aug-11 9:52 
does anyone know how to modify the enumseral code so that only the usb port can be populated on the output screen? i've been trying to modify it but haven't find any luck.
GeneralERROR_INVALID_USER_BUFFER PinmemberMaciej Polanczyk11-Dec-08 20:55 
GeneralQuestion on bidirectional USB Pinmembergbeez22-May-08 10:49 
QuestionHow can I get Serial port properties? Pinmembermazhar_cse4-Feb-08 19:08 
QuestionLNK2019 error Pinmemberbob go4-Nov-07 19:46 
QuestionTest for connection to USB bus Pinmembersay.hello5-Oct-06 8:51 
GeneralObtaining the PortName PinmemberPatrickA26-Nov-04 1:01 
GeneralRemoval relations Pinmemberyonalevine9-Nov-04 22:29 
GeneralUsing SetupAPI Functions Pinsussmajid taghiloo7-Jun-04 23:03 
GeneralClaim/Release SerialPort Pinmemberorfeas2913-Apr-04 0:08 
GeneralUSB/Serial cables in Win98 &amp; WinME PinmemberHoward C. Anderson10-Nov-03 5:26 
QuestionHow to identify application which has access to port? PinmemberJoerg Hoffmann10-Apr-03 23:35 
AnswerRe: How to identify application which has access to port? PinmemberZach Gorman11-Apr-03 5:00 
QuestionAny idea how to get friendly names on NT? PinmemberJoerg Hoffmann10-Apr-03 4:54 
AnswerRe: Any idea how to get friendly names on NT? PinmemberZach Gorman10-Apr-03 6:19 
GeneralRe: Any idea how to get friendly names on NT? PinmemberJoerg Hoffmann10-Apr-03 20:22 
GeneralFTDI(Win98) and PCI modem(WinXP) PinsussPabloII22-Dec-02 20:59 
GeneralRe: FTDI(Win98) and PCI modem(WinXP) PinmemberZach Gorman7-Jan-03 9:40 
GeneralRe: FTDI(Win98) and PCI modem(WinXP) PinmemberChristian B21-Apr-03 9:05 
GeneralRe: FTDI(Win98) and PCI modem(WinXP) PinmemberSamuliA4-Sep-06 23:26 
GeneralRe: FTDI(Win98) and PCI modem(WinXP) Pinmembergrandmasta14-Nov-07 21:32 
GeneralData Structure Item Missing in EnumPortsWdm Pinmemberavidgator7-Aug-02 5:25 
GeneralRe: Data Structure Item Missing in EnumPortsWdm PinmemberZach Gorman10-Aug-02 7:36 
GeneralRe: Data Structure Item Missing in EnumPortsWdm PinmemberChristian B21-Apr-03 9:02 
GeneralRe: Data Structure Item Missing in EnumPortsWdm PinmemberPeter Wurmsdobler10-Jun-04 3:40 
GeneralToo complicated -> use GetDefaultCommConfig() PinmemberAndre Gleichner22-Jul-02 2:17 
GeneralRe: Too complicated -> use GetDefaultCommConfig() PinmemberZach Gorman22-Jul-02 18:27 
GeneralRe: Too complicated -> use GetDefaultCommConfig() PinmemberJoerg Hoffmann24-Apr-03 21:46 
GeneralRe: Too complicated -&gt; use GetDefaultCommConfig() PinmemberMike Pulice23-Dec-03 6:26 
GeneralRe: Too complicated -&gt; use GetDefaultCommConfig() PinmemberZach Gorman4-Jan-04 14:23 
GeneralRe: Too complicated -&gt; use GetDefaultCommConfig() [modified] PinmemberCrashTest31-Aug-09 9:22 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

| Advertise | Privacy | Mobile
Web04 | 2.8.140721.1 | Last Updated 21 Jul 2002
Article Copyright 2002 by Zach Gorman
Everything else Copyright © CodeProject, 1999-2014
Terms of Service
Layout: fixed | fluid