summaryrefslogtreecommitdiff
path: root/serial/VirtualSerial
diff options
context:
space:
mode:
authorBarry Golden <[email protected]>2019-09-25 19:35:57 -0700
committerGitHub <[email protected]>2019-09-25 19:35:57 -0700
commitd2a01860208bcce9f4777d54bec3c59c4c02e969 (patch)
treebe2892ff05b3308b559e18474f1b1645582cb379 /serial/VirtualSerial
parent2e237713e298495b141560a5e7c76d6b1efa0153 (diff)
Diffstat (limited to 'serial/VirtualSerial')
-rw-r--r--serial/VirtualSerial/README.md25
1 files changed, 9 insertions, 16 deletions
diff --git a/serial/VirtualSerial/README.md b/serial/VirtualSerial/README.md
index 05c1f385..3eeb9764 100644
--- a/serial/VirtualSerial/README.md
+++ b/serial/VirtualSerial/README.md
@@ -8,37 +8,30 @@ products:
- windows-wdk
---
-
-<!---
- name: Virtual serial driver sample
- platform: UMDF1
- language: cpp
- category: Serial
- description: Demonstrates a simple virtual serial driver (ComPort) and a controller-less modem driver (FakeModem).
- samplefwlink: http://go.microsoft.com/fwlink/p/?LinkId=617963
---->
-
# Virtual serial driver sample
This sample demonstrates these two serial drivers:
- A simple virtual serial driver (ComPort)
+
- A controller-less modem driver (FakeModem).This driver supports sending and receiving AT commands using the ReadFile and WriteFile calls or via a TAPI interface using an application such as, HyperTerminal.
This sample driver is a minimal driver meant to demonstrate the usage of the User-Mode Driver Framework. It is not intended for use in a production environment.
-For more information, see [Serial Controller and Device Drivers](http://msdn.microsoft.com/en-us/library/windows/hardware/ff546939) in the WDK documentation.
+For more information, see the [Serial Controller Driver Design Guide](https://docs.microsoft.com/windows-hardware/drivers/serports/).
## Code tour
-### comsup.cpp & comsup.h
+### comsup.cpp and comsup.h
- COM Support code - specifically base classes which provide implementations for the standard COM interfaces **IUnknown** and **IClassFactory** which are used throughout the sample.
+
- The implementation of **IClassFactory** is designed to create instances of the CMyDriver class. If you should change the name of your base driver class, you would also need to modify this file.
### dllsup.cpp
- DLL Support code - provides the DLL's entry point as well as the single required export (**DllGetClassObject**).
+
- These depend on comsup.cpp to perform the necessary class creation.
### exports.def
@@ -49,15 +42,15 @@ For more information, see [Serial Controller and Device Drivers](http://msdn.mic
- This is the main header file for the sample driver.
-### driver.cpp & driver.h
+### driver.cpp and driver.h
- Definition and implementation of the driver callback class (CMyDriver) for the sample. This includes **DriverEntry** and events on the framework driver object.
-### device.cpp & driver.h
+### device.cpp and driver.h
- Definition and implementation of the device callback class (CMyDriver) for the sample. This includes events on the framework device object.
-### queue.cpp & queue.h
+### queue.cpp and queue.h
- Definition and implementation of the base queue callback class (CMyQueue). This includes events on the framework I/O queue object.
@@ -67,4 +60,4 @@ For more information, see [Serial Controller and Device Drivers](http://msdn.mic
### VirtualSerial.inf / FakeModem.inf
-- INF file that contains installation information for this driver. \ No newline at end of file
+- INF file that contains installation information for this driver.