Edit

DEBUG_OUTCTL_XXX

  • Article

The DEBUG_OUTCTL_XXX constants are used for output control. The constants form a bit field that specifies the current policy of where to send output. The bit field is divided into two sections.

The lower bits must be exactly one of the following values.

Value Description

DEBUG_OUTCTL_THIS_CLIENT

Output generated by methods called by this client will be sent only to this client's output callbacks.

DEBUG_OUTCTL_ALL_CLIENTS

Output will be sent to all clients.

DEBUG_OUTCTL_ALL_OTHER_CLIENTS

Output will be sent to all clients (except to the client that generated the output).

DEBUG_OUTCTL_IGNORE

Output will be discarded immediately and will not be logged or sent to callbacks.

DEBUG_OUTCTL_LOG_ONLY

Output will be logged but not sent to callbacks.

The higher bits of the bit field may contain the following values.

Value Description

DEBUG_OUTCTL_NOT_LOGGED

Do not put output from this client in the global log file.

DEBUG_OUTCTL_OVERRIDE_MASK

Sends output to clients regardless of whether the client's output mask allows it.

DEBUG_OUTCTL_DML

For output that supports Debugger Markup Language (DML), sends the output in DML format.

To create a valid output control bit-field, take exactly one value from the first table, along with zero or more values from the second table, and combine them by using the bitwise-OR operator.

The default value of the output control bit-field is DEBUG_OUTCTL_ALL_CLIENTS.

As an alternative to creating your own output control bit-field, you can use one of the following values.

Value Description

DEBUG_OUTCTL_AMBIENT_DML

Sets the new output control to the same value as the current output control and specifies that the output will be in DML format.

DEBUG_OUTCTL_AMBIENT_TEXT

Sets the new output control to the same value as the current output control and specifies that the output will be in text format.

DEBUG_OUTCTL_AMBIENT

Same as DEBUG_OUTCTL_AMBIENT_TEXT.

Requirements

Header

 DbgEng.h (include DbgEng.h)