summaryrefslogtreecommitdiff
path: root/print/v4PrintDriverSamples/v4PrintDriver-HostBasedSampleDriver/README.md
diff options
context:
space:
mode:
authorBarry Golden <[email protected]>2019-03-12 14:02:43 -0700
committerAdonais Romero González <[email protected]>2019-03-12 14:02:43 -0700
commitef7ec4ec9ff7ce3c53d60e1c8906915966e17e01 (patch)
tree3017523a73c6552c27947d402afa6062f4df2706 /print/v4PrintDriverSamples/v4PrintDriver-HostBasedSampleDriver/README.md
parent35bff356ac249057f4d673d39c7f28ed348cbf0f (diff)
Update README.md for samples portal (#358)
* Update README.md for samples portal * Update README.md for samples portal * Removed installwdf * Update fork (#2) * Fix typo ture -> true * Remove InstallWdf sample * Fix typo (#340) ture -> true * Readme typo fix (#349) * Update langid
Diffstat (limited to 'print/v4PrintDriverSamples/v4PrintDriver-HostBasedSampleDriver/README.md')
-rw-r--r--print/v4PrintDriverSamples/v4PrintDriver-HostBasedSampleDriver/README.md51
1 files changed, 25 insertions, 26 deletions
diff --git a/print/v4PrintDriverSamples/v4PrintDriver-HostBasedSampleDriver/README.md b/print/v4PrintDriverSamples/v4PrintDriver-HostBasedSampleDriver/README.md
index fee078b0..608eac8b 100644
--- a/print/v4PrintDriverSamples/v4PrintDriver-HostBasedSampleDriver/README.md
+++ b/print/v4PrintDriverSamples/v4PrintDriver-HostBasedSampleDriver/README.md
@@ -1,3 +1,14 @@
+---
+topic: sample
+name: USB Host-Based Print Driver Sample
+description: Demonstrates how to support host-based devices that use the v4 print driver model and are connected via USB.
+languages:
+ - javascript
+ - xml
+products:
+ - windows
+---
+
<!---
name: USB Host-Based Print Driver Sample
platform: Utility
@@ -7,10 +18,7 @@
samplefwlink: http://go.microsoft.com/fwlink/p/?LinkId=617947
--->
-
-
-USB Host-Based Print Driver Sample
-==================================
+# 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.
@@ -28,44 +36,35 @@ The Bidi schema is a hierarchy of printer attributes, some of which are properti
*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*
-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](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).
Here are the core files that you will find in this sample:
-File name
-
-Description
+**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:
+ - Determine if the device is ready to receive data
+ - Check to see if there is an error condition
+ - Read the device status
-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:
+**usb\_host\_based\_sample\_events.xml**
-- Determine if the device is ready to receive data
-- Check to see if there is an error condition
-- Read the device status
+- 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\_events.xml
+**usb\_host\_based\_sample\_extension.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 USB Bidi Extension XML file that specifies the supported Bidi Schema elements for this driver.
-usb\_host\_based\_sample\_extension.xml
-
-A USB Bidi Extension XML file that specifies the supported Bidi Schema elements for this driver.
-
-
-Build the sample
-----------------
+## 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).
-Run the sample
---------------
+## 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.
-