Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All
Important This document may not represent best practices for current development, links to downloads and other resources may no longer be valid. Current recommended version can be found here.

HxComp.exe 

Command-line program that builds compiled Help (.HxS) files from Microsoft Help project files.


Hxcomp [-p[project filename]] [-l [ANSI/DBCS log filename]] [-n [unicode log filename]] [-r [project root]][-o [output filename]] [-i] [-e] [-w] [-q] [-u [decompiled filename]] [-d [decompile output directory]] [-?]

The following table describes the command-line options that are available.

Option Value Description

-p

project filename

Specifies the path to the collection definition (.HxC) file to compile.

-l

ANSI/DBCS log filename

Specifies the file name and path for the log file used to list informational, warning, and error messages that occurred while compiling.

This option generates a log file in ANSI/DBCS file format.

If this option is not used, no log file is generated.

-n

Unicode log filename

Specifies the file name and path for the log file used to list informational, warning, and error messages that occurred while compiling.

This option generates a log file in Unicode file format.

If this option is not used, no log file is generated.

-r

project root

Specifies the full path of the root directory for the project.

-o

output filename

Specifies an alternative file name for the compiled Help (.HxS) output file. If this option is not used, the output file will be given the same name as the .HxC file, with the .HxS extension.

-i

None

Instructs the compiler not to generate informational messages.

-e

None

Instructs the compiler not to generate error messages.

-w

None

Instructs the compiler not to generate warning messages.

-q

None

Instructs the compiler to run in quiet mode. This option prevents the command console from appearing when HxComp.exe is executed.

-u

decompiled file name

Specifies the path to the .HxS file to decompile.

-d

decompile output directory

Specifies the path to the directory in which to save source files resulting from a decompile operation.

-?

None

Displays the commands for HxComp.exe.

The following example creates a compiled Help (.HxS) file from a collection definition (.HxC) file named myproject.hxc, and specifies that a log file named log.txt be generated in the root directory.

hxcomp -p c:\myproject\source\myproject.hxc -r c:\myproject\source -l c:\myproject\source\log.txt

The following example shows how to decompile an .HxS file:

hxcomp -d c:\myproject\myhelpfile.hxs -u c:\myproject\decompile

Community Additions

ADD
Show:
© 2015 Microsoft