Conventions Used in This Book

Most of the conventions in this book are the same as those in the WDK documentation and in other Microsoft products for programmers. In addition, this book provides references to help you find the samples, documentation topics, white papers, tools, or other information in each specific discussion. Table 1.1 summarizes the typographical and other conventions used in this book.

Table 1-1: Documentation Conventions
Open table as spreadsheet

This convention …	Indicates …
bold	System-supplied or system-defined functions and support routines, structure members, enumerators, and registry key names. These items appear in the system header files that are included with the WDK exactly as shown in this documentation. For example, WdfCreateDevice is a system-supplied function that supports kernel-mode WDF drivers.
italic	Placeholder function names, formal parameters, or any other text that is meant for you to replace in your own code. Portions of registry paths or INF entries in italics are placeholders, to be replaced with driver- or device-specific text. For example: EvtDriverDeviceAdd is a placeholder name for a callback function that the driver defines. #pragma warning(disable:WarningNumber) uses a placeholder for a numeric value that would appear in an actual warning.
Monospace	Code examples, such as: hwInitData.DeviceIdLength=4
UPPERCASE	Constant identifiers, data type names, bitwise operators, and system-supplied macros. Uppercase identifiers must be typed exactly as shown. For example, WDF_DRIVER_CONFIG is a system-defined structure.
Filename.txt	The name of a file. This book shows file names in upper and lower case type for better readability. File names are not case-sensitive.
%wdk%	The root installation directory for the WDK-typically, C:\WinDDK\BuildNumber.
%windir%	The root installation directory for the Windows operating system-typically, C:\Windows.
x86, x64, Itanium	References to the different CPU architectures that run Windows, specifically: x86 for 32-bit processors that run the Intel instruction set, x64 for 64-bit processors such as AMD64, and Itanium for Intel Itanium processors.
\<i386 | amd64 | ia64>	Alternative subdirectories in a WDK folder that contain files for the different hardware platforms, specifically: i386 for x86 versions of Windows, amd64 for x64 versions of Windows, and ia64 for 64-bit Windows on the Itanium platform. For example: %wdk%\tools\acpi\i386\.

Finding Resources for Each Chapter

Each chapter begins with a list of the samples, documentation, and tools you need to follow along on your personal workstation. The following shows an example.

For this chapter, you need …	From …
Tools and files
Build.exe	%wdk%\bin\<amd64 | ia64 | i386>
Sample drivers
Fx2_Driver	%wdk%\src\umdf\usb\fx_2driver
Osrusbfx2	%wdk%\src\kmdf\Osrusbfx2
WDK documentation
UMDF Objects and Interfaces	http://go.microsoft.com/fwlink/?LinkId=79583
Other
"Developing Drivers with WDF: News and Updates" on the WHDC Web site	http://go.microsoft.com/fwlink/?LinkId=80911

The WDK topics listed in each chapter's resources include links to the online version of the documentation on MSDN. Other links are for white papers and Web-based resources. You can find all these references as convenient hyperlinks at "Developing Drivers with WDF: News and Updates" on the WHDC Web site.