summaryrefslogtreecommitdiff
path: root/print/v4PrintDriverSamples/v4PrintDriver-HostBasedSampleDriver/README.md
diff options
context:
space:
mode:
authorBarry Golden <[email protected]>2019-09-25 07:54:18 -0700
committerGitHub <[email protected]>2019-09-25 07:54:18 -0700
commit2e237713e298495b141560a5e7c76d6b1efa0153 (patch)
tree552f09c62562d62e3b8f2701f223f6f53792403e /print/v4PrintDriverSamples/v4PrintDriver-HostBasedSampleDriver/README.md
parent16022c593787aef040b8a37ef697316e07f1322e (diff)
Diffstat (limited to 'print/v4PrintDriverSamples/v4PrintDriver-HostBasedSampleDriver/README.md')
-rw-r--r--print/v4PrintDriverSamples/v4PrintDriver-HostBasedSampleDriver/README.md51
1 files changed, 23 insertions, 28 deletions
diff --git a/print/v4PrintDriverSamples/v4PrintDriver-HostBasedSampleDriver/README.md b/print/v4PrintDriverSamples/v4PrintDriver-HostBasedSampleDriver/README.md
index 0fc9a4b0..3c7bfba2 100644
--- a/print/v4PrintDriverSamples/v4PrintDriver-HostBasedSampleDriver/README.md
+++ b/print/v4PrintDriverSamples/v4PrintDriver-HostBasedSampleDriver/README.md
@@ -9,22 +9,12 @@ products:
- windows-wdk
---
-
-
-<!---
- name: USB Host-Based Print Driver Sample
- platform: Utility
- language: js xml
- category: Print
- description: Demonstrates how to support host-based devices that use the v4 print driver model and are connected via USB.
- samplefwlink: http://go.microsoft.com/fwlink/p/?LinkId=617947
---->
-
# USB Host-Based Print Driver Sample
This driver sample demonstrates how to support host-based devices that use the v4 print driver model, and are connected via USB.
-**Note** This sample is for the v4 print driver model.
+> [!NOTE]
+> This sample is for the v4 print driver model.
Windows enables manufacturers to support Bidirectional Communication (Bidi) for USB devices, by using a combination of both a Bidi XML file and a Javascript file known as a USB Bidi extender. The *usb\_host\_based\_sample.js* file that is included with the sample, plays the role of the USB Bidi extender.
@@ -34,39 +24,44 @@ By default, Bidi queries and status requests are routed over the USB device inte
In addition to extending Bidi communication, this driver sample also specifies the schema elements that it supports. The *usb\_host\_based\_sample\_extension.xml* file that is included with the sample, provides information about the supported schema elements.
-The Bidi schema is a hierarchy of printer attributes, some of which are properties and others that are values (or value entries).
+The Bidi schema is a hierarchy of printer attributes, some of which are properties and others that are values (or value entries):
-*Property*
+- *Property*
+
+ - A property is a node in the schema hierarchy. A property can have one or more children, and these children can be other properties or values.
-- A property is a node in the schema hierarchy. A property can have one or more children, and these children can be other properties or values.
+- *Value*
-*Value*
+ - A value is a leaf in the schema hierarchy that represents either a single data item or a list of related data items. A value has a name, a data type, and a data value. A value cannot have child elements.
-- A value is a leaf in the schema hierarchy that represents either a single data item or a list of related data items. A value has a name, a data type, and a data value. A value cannot have child elements.
+For more information, see [USB Bidi Extender](https://docs.microsoft.com/windows-hardware/drivers/print/usb-bidi-extender) and [Bidi Communication Schema](https://docs.microsoft.com/windows-hardware/drivers/print/bidirectional-communication-schema).
-For more information, see [USB Bidi Extender](http://msdn.microsoft.com/en-us/library/windows/hardware/jj659903(v=vs.85).aspx) and [Bidi Communication Schema](http://msdn.microsoft.com/en-us/library/windows/hardware/ff545169(v=vs.85).aspx).
+## File manifest
Here are the core files that you will find in this sample:
-**usb\_host\_based\_sample.js**
+### usb\_host\_based\_sample.js
+
+A USB Bidi Extension JavaScript file which includes support for controlling printing for host-based devices. This is the only code in the driver sample. It is invoked by USBMon and it communicates with the device to do the following:
-- A USB Bidi Extension JavaScript file which includes support for controlling printing for host-based devices. This is the only code in the driver sample. It is invoked by USBMon and it communicates with the device to do the following:
- Determine if the device is ready to receive data
- - Check to see if there is an error condition
- - Read the device status
+
+- Check to see if there is an error condition
+
+- Read the device status
-**usb\_host\_based\_sample\_events.xml**
+### usb\_host\_based\_sample\_events.xml
-- A 'driver events' XML file that specifies an event which detects when the user needs to flip over the paper in the tray.
+A 'driver events' XML file that specifies an event which detects when the user needs to flip over the paper in the tray.
-**usb\_host\_based\_sample\_extension.xml**
+### usb\_host\_based\_sample\_extension.xml
-- A USB Bidi Extension XML file that specifies the supported Bidi Schema elements for this driver.
+A USB Bidi Extension XML file that specifies the supported Bidi Schema elements for this driver.
## Build the sample
-For information and instructions about how to test and deploy drivers, see [Developing, Testing, and Deploying Drivers](http://msdn.microsoft.com/en-us/library/windows/hardware/ff554651(v=vs.85).aspx).
+For information and instructions about how to test and deploy drivers, see [Developing, Testing, and Deploying Drivers](https://docs.microsoft.com/windows-hardware/drivers/develop/).
## Run the sample
-To understand how to run this sample as a Windows driver, see the [v4 Printer Driver](http://msdn.microsoft.com/en-us/library/windows/hardware/hh706306(v=vs.85).aspx) collection of topics. \ No newline at end of file
+To understand how to run this sample as a Windows driver, see the [v4 Printer Driver](https://docs.microsoft.com/windows-hardware/drivers/print/v4-printer-driver) collection of topics.