HyperX.Solver.Api
The HyperX Solver Application Programming Interface
Loading...
Searching...
No Matches
Debugging: Visual Studio

The following steps describe how to debug custom analysis criteria using Visual Studio 2022. The general process is similar in other IDEs and debuggers.

  1. In Solution Explorer, right click your custom criteria project and select Set as Startup Project.
    Step 1 Image

  2. Select your project's Debug Properties to open the Launch Profiles UI.
    Step 2 Image

  3. Create a new profile of type Executable.
    Step 3 Image

  4. Set the Executable path to: <InstallDir>\Executable\Solver\HyperX.Solver.exe
    Step 4 Image

  5. Enter the Command-line arguments:

    • <input file> — Path to the solver_input.msgpack file ("<ProjectWorkingFolder>\Solver\solver_input.msgpack")
    • <status file> — Path to your solver_log.txt file ("<ProjectWorkingFolder>\Solver\solver_log.txt")
    • <output file> — Path to your solver_output.msgpack file ("<ProjectWorkingFolder>\Solver\solver_output.msgpack")
    • <working folder> — Path to your overall temp directory ("<ProjectWorkingFolder>")
    • <package cache directory> — Path to your package cache directory ("C:\HyperX\Packages\Cache")
    • <input file format> — Specifies the input file format. Must be set to: 3 (MessagePack)
    • <output file format> — Specifies the output file format. Must be set to: 4 (SQL)
    • <output mode> — Specifies the output mode: 0 (Overwrite) or 1 (Append)
    • <run name> — User-defined name for the Solver run
    • <number of threads> — Number of threads to use (must be ≥ 1)

    Step 5 Image

    Note
    See how to generate the Solver CLI arguments from the HyperX Script Runner.
  6. Set the Working directory to: <InstallDir>\Executable\Solver
    Step 6 Image

  7. Review and confirm the full debug configuration.
    Step 7 Image

  8. Select the newly created debug profile.
    Step 8 Image

  9. Set a breakpoint in your criterion code.
    Step 9 Image

  10. Start debugging via Debug -> Start Debugging.
    Step 10 Image

  11. Inspect variables while debugging
    Step 11 Image