GDLCheck

Note  This content applies to the Windows Logo Kit (WLK). For the latest information using the new Windows Hardware Certification Kit (HCK), see Windows HCK User's Guide on the Windows Hardware Dev Center.

Overview

The GDLCheck tool is a GDL syntax checker that enables you to parse and load GDL files, specify configurations, and obtain XML snapshots.

Details

All parsing errors and debug output from this test are sent to Gdlcheck.xml. The command-line arguments are processed from left to right. Each argument is separated from the next with a space character. You need to specify all options before you specify the GDL root file name.

You can run this test tool from the Microsoft Windows Driver Kit (WDK) or stand-alone from the command prompt. This tool logs results to a WTT log file and you can configure the tool to log information at different verbosity levels. The tool requires the root GPD/GDL file that is being validated and any additional GPD or GDL files that the root file references.

Run Time:

Log File:

System Restart Required:

Test Category:

Supported operating systems for Logo or Signature testing:

• Windows 7

• Windows Server 2008 R2

• Windows Vista

• Windows Server 2003

• Windows XP

Program:

Requirements

Software Requirements

The test tool requires the following software:

• Supported operating system (see list above)

• Software components included with the device that is being tested

Hardware Requirements

The test tool requires the following hardware:

• Computer that meets the minimum software requirements

Processor

• x86

• x64

• Itanium

Running GDLCheck

All debug output from GDLCheck is written to the GDLCheck.xml file.

The syntax for this tool is as follows:

GDLCheck.exe [-Verbosity=n], where n is a number from 0 to 4 specifying

the verbosity level of parser messages. Verbosity 4

is the most verbose and Verbosity 0 is the least verbose.

[-Personality[=persona]] Generate Personality Aware snapshot.

(To enable all personalities, use -Personality alone.)

[-DisplaySynthesizedFeatures]

[-GenerateSchema] (GDLschema.xsd) for XML snapshot.

[-DoNotGenerateXMLSnapshot]

[-DisplayOnlyStickyFeatures]

[-DisplayValidatedConfiguration]

[-ParserContext=n] where n is a number from 0 to 9. Initial context is 0.

[-PrefaceFile=<full path to file that holds Preface>]

[-DeviceConfiguration[=Feature1.Option1[:Feature2.Option2[:Feature3.Option3...]]]

[-DocumentConfiguration[=Feature1.Option1[:Feature2.Option2[:Feature3.Option3...]]]

(Always generates XML Snapshot.)

<-PrinterName=<name of an installed printer> | GDL root file path1 [GDL root file path2...]>

[-?] Display this message.

The following list describes some example GDLCheck commands:

• GDLCheck.exe -DisplayValidatedConfiguration -DeviceConfiguration -DocumentConfiguration basic.gdl

  The preceding command produces an XML snapshot in GDLsnapshot.xml by using the default device and document configurations. basic.gdl implements the basic features that you need to satisfy the root construct productions that are defined in stdschem.gdl. The following debug output shows an example of what occurs if you specify the -DisplayValidatedConfiguration option.

  ==== Validated Configuration ====

  PaperSize:LETTER

  Resolution:Option1

  RESDLL:UniresDLL

  InputBin:UPPER

  If you execute the same command with hplj5si.gdl (instead of basic.gdl), you will see the following debug output.

  ==== Validated Configuration ====

  Memory:4096KB

  PrinterHardDisk:FALSE

  DuplexUnit:Installed

  PageProtect:OFF

  ==== Validated Configuration ====

  Memory:4096KB

  PrinterHardDisk:FALSE

  DuplexUnit:Installed

  PageProtect:OFF

  PaperSize:LETTER

  Orientation:PORTRAIT

  Duplex:NONE

  Resolution:Option1

  Halftone:HT_PATSIZE_AUTO

  RESDLL:UniresDLL

  OutputBin:Option1

  Collate:OFF

  Stapling:Option1

  InputBin:Option1

• GDLCheck.exe -GenerateSchema -DoNotGenerateXmlSnapshot basic.gdl

  The preceding command produces the schema for the XML snapshot but not the snapshot itself. You can find the schema in GDLschema.xsd. This command shows the -GenerateSchema option and the -DoNotGenerateXmlSnapshot option, which turns off snapshot creation. The default behavior of Gdlcheck when the -DoNotGenerateXmlSnapshot option is omitted is to produce the XML snapshot.

• GDLCheck.exe -PrefaceFile=preface.gdl -DisplayValidatedConfiguration -DeviceConfiguration -DocumentConfiguration basic.gdl

  The preceding command shows how you can use the -PrefaceFile option in Gdlcheck to specify a preface file. To perform the preceding test, you should comment out or remove the "*Include: "stdschmx.gdl" line from basic.gdl because preface.gdl already includes this line. The result of running the preceding command should be the same as in the first example command.

• GDLCheck.exe -DisplaySynthesizedFeatures -DoNotGenerateXmlSnapshot synfea.gdl

  The preceding command shows depicts how you can use the -DisplaySynthesizedFeatures option to verify the creation of synthesized features. The following debug output shows an example of what occurs if you run the preceding command. Because the -DoNotGenerateXmlSnapshot option is used, the XML snapshot will not be created.

  === Begin Contents of Synthesized Features Buffer ===

  *Feature: SynFea_InputBinENVFEED

  {

  *FeatureType: SYNTHESIZED_PROPERTY

  *Name: "Optional Envelope Feeder"

  *Option: NotInstalled

  {

  *Name: "Not installed"

  *Constraints: InputBin.ENVFEED

  }

  *Option: Installed

  {

  *Name: "Installed"

  }

  }

  === End Contents of Synthesized Features Buffer ===

  Note that the -DoNotGenerateXmlSnapshot option not a requirement to use the -DisplaySynthesizedFeatures option. You could also use GDLCheck.exe -DisplaySynthesizedFeatures -DisplayValidatedConfiguration -DeviceConfiguration -DocumentConfiguration synfea.gdl, which would produce the following debug output.

  === Begin Contents of Synthesized Features Buffer ===

  *Feature: SynFea_InputBinENVFEED

  {

  *FeatureType: SYNTHESIZED_PROPERTY

  *Name: "Optional Envelope Feeder"

  *Option: NotInstalled

  {

  *Name: "Not installed"

  *Constraints: InputBin.ENVFEED

  }

  *Option: Installed

  {

  *Name: "Installed"

  }

  }

  === End Contents of Synthesized Features Buffer ===

  ==== Validated Configuration ====

  SynFea_InputBinENVFEED:NotInstalled

  ==== Validated Configuration ====

  SynFea_InputBinENVFEED:NotInstalled

  PaperSize:LETTER

  Resolution:Option1

  RESDLL:UniresDLL

  InputBin:UPPER

• GDLCheck.exe -DisplayValidatedConfiguration -DeviceConfigurationMemory.8192KB:PrinterHardDisk.TRUE -cOrientation.LANDSCAPE_CC90:Resolution.Option2:PaperSize.LEGAL hplj5si.gdl

  The preceding command shows how you can use the -DeviceConfiguration and -DocumentConfiguration options to define the device and document configurations. The usage of these options in the first example causes the default configurations to be used. But this example illustrates how you can define your own configurations. The following debug output shows an example of what you might see from running the preceding command.

  ==== Validated Configuration ====

  Memory:8192KB

  PrinterHardDisk:TRUE

  DuplexUnit:Installed

  PageProtect:OFF

  ==== Validated Configuration ====

  Memory:8192KB

  PrinterHardDisk:TRUE

  DuplexUnit:Installed

  PageProtect:OFF

  PaperSize:LEGAL

  Orientation:LANDSCAPE_CC90

  Duplex:NONE

  Resolution:Option2

  Halftone:HT_PATSIZE_AUTO

  RESDLL:UniresDLL

  OutputBin:Option1

  Collate:OFF

  Stapling:Option1

  InputBin:Option1

• You can use the -ParserContext argument in GDLCheck to validate more than one root GDL file within a single execution of GDLCheck. The syntax for this situation is shown below. This example also illustrates the use of the -Personality option that you can use to specify a personality for the generation of the personality aware XML snapshot.

  GDLCheck.exe -Preface=c:\test\preface.gdl -DisplayValidatedConfiguration -DeviceConfiguration -DocumentConfiguration c:\test\basic.gdl -ParserContext=1 -Preface=c:\test\preface.gdl -DisplayValidatedConfiguration -Verbosity=1 -Personality=Persona1 -GenerateSchema -DeviceConfiguration -DocumentConfiguration c:\test\personatest.gdl

Command Syntax

Build date: 9/14/2012