Debugging your USB Windows Store app with TraceView
Published Oct 12 2018 03:38 PM 6,401 Views
Copper Contributor
First published on MSDN on Jul 03, 2013

Authored by Philip Ries [MSFT]

Last week, at the Microsoft Build Developer Conference-2013 , a new Windows Runtime API ( Windows.Devices.Usb ) was unveiled for Windows 8.1 Preview . Windows Store apps can now use the new API to communicate with USB devices. For more information, see this video .

In this post, I'll provide some instructions that you might find useful while debugging your app.  Follow these instructions on the system that is running your app:

  1. Install Windows Driver Kit 8.1 .

  2. Open an elevated command prompt.

  3. These commands overwrite any existing file named UsbWinRT.ctl . Run these commands by pasting them in the elevated command prompt window:

    echo F849C3C0-E2B0-4FCE-944A-E16EBBB964DC    UsbWinRT > UsbWinRT.ctl
    echo EF201D1B-4E45-4199-9E9E-74591F447955    WinUsb >> UsbWinRT.ctl
    "%PROGRAMFILES(X86)%\Windows Kits\8.0\Tools\x64\traceview.exe"

    The preceding commands,

    • Set up the Microsoft public symbol server path.

    • Generate a CTL file that contains the specified control GUIDs of the trace providers. In this case, those GUIDs indicate Windows.Devices.Usb and WinUsb . In the generated UsbWinRT.ctl file, each line contains the GUID and a friendly name of the provider. We’ll use the CTL file in the following instructions.

    • Launch TraceView that allows you to capture trace messages. On non-x64 systems, you must change the last line to "%PROGRAMFILES%\Windows Kits\8.1\Tools\x86\traceview.exe" .

  4. In TraceView, check the symbols by selecting Options -> Configure Symbols . If not included, add to the symbol path and click OK .

  5. Click File -> Create New Log Session .

  6. Click Add Provider .

  7. Select CTL (Control GUID) File .

  8. Click the ... button and select the UsbWinRT.ctl file that was created by using the commands in step 3.

  9. Click OK .

  10. Close the Format Information Source dialog by clicking Cancel .

  11. Click Next and then Finish on the next page. The trace session starts automatically.

  12. Run your app and perform the actions that you want to capture.

  13. View trace messages in Traceview.

    The messages shown in Traceview are debug trace statements for the trace providers specified in step 3:

If you are trying to analyze errors originating from the device, it's best to use a USB ETW trace or a hardware bus trace.

Happy coding!

Version history
Last update:
‎Oct 12 2018 03:38 PM
Updated by: