2.2.9 Tool Helper Functions

The tool helper functions simplify the job of writing Windows-hosted debugging applications.

Following are the new tool helper functions:

Function Description

ClassFirst Retrieves information about the first class in the class list.
ClassNext Retrieves information about the next class in the class list.
GlobalEntryHandle Retrieves information about a global memory object.
GlobalEntryModule Retrieves information about a specific memory object.
GlobalFirst Retrieves information about the first global memory object.
GlobalHandleToSel Converts a global handle to a selector.
GlobalInfo Retrieves information about the global heap.
GlobalNext Retrieves information about the next global memory object.
InterruptRegister Installs a function to handle system interrupts.
InterruptUnRegister Removes the function that processed system interrupts.
LocalFirst Retrieves information about the first local memory object.
LocalInfo Fills a structure with information about the local heap.
LocalNext Retrieves information about the next local memory object.
MemManInfo Retrieves information about the memory manager.
MemoryRead Reads memory from an arbitrary global heap object.
MemoryWrite Writes memory to an arbitrary global heap object.
ModuleFindHandle Retrieves information about a module.
ModuleFindName Retrieves information about a module.
ModuleFirst Retrieves information about the first module.
ModuleNext Retrieves information about the next module.
NotifyRegister Installs a notification callback function.
NotifyUnRegister Removes a notification callback function.
StackTraceCSIPFirst Retrieves information about a stack frame.
StackTraceFirst Retrieves information about the first stack frame.
StackTraceNext Retrieves information about the next stack frame.
SystemHeapInfo Retrieves information about the USER heap.
TaskFindHandle Retrieves information about a task.
TaskFirst Retrieves information about the first task in the task queue.
TaskGetCSIP Returns the next CS:IP value of a task.
TaskNext Retrieves information about the next task in the task queue.
TaskSetCSIP Sets the CS:IP of a sleeping task.
TaskSwitch Switches to a specific address within a new task.
TerminateApp Terminates an application.
TimerCount Retrieves execution times.

The tool helper feature depends on the dynamic-link library TOOLHELP.DLL. The DLL requires a modified version of the virtual timer device VTD.386 to provide additional support for the TimerCount function. Applications that use this function must install the virtual timer device by adding an appropriate device= entry in the [386Enh] section of the SYSTEM.INI file. Both TOOLHELP.DLL and VTD.386 are redistributable files.