Debug Message API Functions

This section lists the supported Debug Message functions.

Function Description

RtdbgCloseBasicChannel

Closes the Basic message channel for the current process.

RtdbgCloseChannel

Closes a Standard or Trace message channel.

RtdbgCreateStandardChannel

Creates a Standard message channel. This channel is identified by the combination of VendorId, ProductCode, and ChannelId. If a channel with the same combination already exists, it will be opened.

RtdbgCreateTraceChannel

Creates a Trace message channel. This channel is identified by the combination of VendorId, ProductCode, and ChannelId. If a channel with the same combination already exists, it will be opened.

RtdbgGetBasicCategoryName

Gets the display name of a message category.

RtdbgGetBasicMessage

Gets the first Basic message in the queue.

RtdbgGetCategoryFilter

Reads the current category filter value. This value is a bitmap indicating which categories are enabled.

RtdbgGetIndexFilter

Reads the current index filter value for a trace source, which is an array containing a set of four short values indicating which indexes are enabled for this source. If the first short value is set to -1, all indexes are enabled. If the value is set to RTDBG_FILTER_DISABLED, the filter is disabled and all indexes are allowed.

RtdbgGetMessage

Gets the first Standard or Trace message in the queue.

RtdbgGetSeverityFilter

Reads the current severity filter value. This value is a bitmap indicating which severity levels are enabled.

RtdbgGetSourceFilter

Reads the current source filter value. This value is a bitmap indicating which sources are enabled in the channel.

RtdbgGetTypeFilter

Reads the current type filter value. This value is a bitmap indicating which types are enabled in the channel.

RtdbgOpenBasicChannel

Opens the Basic message channel for the current process.

RtdbgSendBasicMessage

Sends a Basic message.

RtdbgSendBasicMessageIsr

Sends a Basic message from an Interrupt Service Routine (ISR).

RtdbgSendMessage

Sends a Standard or Trace message.

RtdbgSendMessageIsr

Sends a Standard or Trace message from an Interrupt Service Routine (ISR).

RtdbgSetBasicCategoryName

Sets the display name for a message category.

RtdbgSetCategoryFilter

Writes the category filter value. This value is a bitmap indicating which categories are enabled.

RtdbgSetIndexFilter

Writes the index filter value for a trace source. A set of four short values indicating which indexes are enabled for this source. To enable all indexes, set the first short value to -1. To enable all indexes and disable the filter, set the value to RTDBG_FILTER_DISABLED.

RtdbgSetSeverityFilter

Writes the severity filter value. This value is a bitmap indicating which severity levels are enabled.

RtdbgSetSourceFilter

Writes the source filter value. This value is a bitmap indicating which sources are enabled in the channel.

RtdbgSetTypeFilter

Writes the type filter value. This value is a bitmap indicating which types are enabled in the channel.

RtdbgSynchronizeIsrCounter

Resets the offset between RtGetClockTime and QueryPerformanceCounter used to timestamp Interrupt Service Routine (ISR) messages.