DEBUGREGISTER, RETAILREGISTERZONES

8/28/2008

These macros register the current module (a DLL or process) and its associated debug zone with the kernel subsystem.

DEBUGREGISTER registers debug zones for your process or module only on Debug builds.
RETAILREGISTERZONES registers debug zones on Debug and Retail builds.

To always register debug zones, regardless of what build settings that you use, use the RegisterDbgZones function.

Syntax


DEBUGREGISTER (hMod) 
RETAILREGISTERZONES  (hMod)

Parameters

hMod: Module handle.

Return Value

None.

Remarks

Any module (a DLL or process) can register an associated debug zone mask that uses this macro with the kernel debug subsystem. Once the debug zones are registered, a user can then turn debug zones on or off programmatically using the techniques described in Changing Debug Zones.

Debug zones may also be turned on or off interactively from the Target Control window. You can interactively turn debug zones on or off by modifying bits of the registered debug zone mask.

You can call one of these macros from the main function of your process, or from the DllMain entry point of your DLL. For example, from the main function of a process, you might call:

 DEBUGREGISTER(NULL);

Alternatively, from the entry point of a DLL, call:

 DEBUGREGISTER(hInstDLL);

Where hInstDLL is the instance value that was passed to DllMain.

The design of this macro assumes that a global variable dpCurSettings has already been defined, where dpCurSettings must be a DBGPARAM structure.

Requirements

Header	dbgapi.h
Windows Embedded CE	Windows CE 2.10 and later
Windows Mobile	Windows Mobile Version 5.0 and later

Reference

DEBUGZONE