TraceLoggingDescription macro (traceloggingprovider.h)

TraceLogging wrapper macro that sets the description for the event.

Syntax

void TraceLoggingDescription(
  [in]  eventDescription
);

Parameters

[in] eventDescription

The description of the event. This value must be a string literal.

Return value

None

Remarks

TraceLoggingDescription("event description") can be used as a parameter to an invocation of a TraceLoggingWrite macro.

If multiple description args are provided, they are concatenated together into a single string.

Event descriptions are stored in the PDB. They are not available at runtime.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps | UWP apps]
Minimum supported server Windows Server 2008 [desktop apps | UWP apps]
Target Platform Windows
Header traceloggingprovider.h

See also

TraceLoggingWrite

TraceLogging wrapper macros