DEBUGMSG

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This macro conditionally outputs a debugging message.

Syntax

DEBUGMSG (
    Condition,
  Printf_expr
) 

Parameters

• Condition
  Boolean expression that is used to determine whether the message would be output.

• Printf_expr
  A printf-style expression to be output. Must be enclosed in parentheses. Will be passed on to the NKDbgPrintf function.

Return Value

None.

Remarks

This macro is a wrapper around NKDbgPrintfW that uses a subset of printf formatting characters to format debugging message output.

This macro may be used to conditionally output a debugging message formatted in printf style. The printf-style message parameter is output if the Boolean input expression evaluates to TRUE. Note that the parameter Message ** must be enclosed by parentheses to prevent syntax errors being generated by the preprocessor.

Example

 DEBUGMSG(TRUE, (TEXT("Testing item count against maximum %u\r\n"),
         dwMaxNumberOfItems));
 DEBUGMSG(dwCurrentNumberOfItems >= dwMaxNumberOfItems,
          (TEXT("Invalid item count! Found %u, expected less than %u\r\n"),
           dwCurrentNumberOfItems, dwMaxNumberOfItems));

Output:

 Testing item count against maximum 68
 Invalid item count! Found 343, expected less than 68

Requirements

See Also

Reference

DEBUGCHK
ERRORMSG
RETAILMSG