Edit

Share via

WppRecorderConfigure macro (wpprecorder.h)

  • Article

The WppRecorderConfigure method enables or disables the default log to which WPP prints.

Syntax

__drv_maxIRQL(PASSIVE_LEVEL)
VOID WppRecorderConfigure(
    _In_         PRECORDER_CONFIGURE_PARAMS  ConfigureParams
    );

Parameters

ConfigureParams

Pointer to a caller-allocated RECORDER_CONFIGURE_PARAMS structure.

Return value

None

Remarks

Before calling WppRecorderConfigure, allocate a RECORDER_CONFIGURE_PARAMS structure and initialize by calling RECORDER_CONFIGURE_PARAMS_INIT.

This method only configures the default log. By default that log is enabled. If you have a custom log, you must disable the default log by setting the CreateDefaultLog to FALSE.

Example

RECORDER_CONFIGURE_PARAMS                recorderConfigure;

RECORDER_CONFIGURE_PARAMS_INIT(&recorderConfigure);
// Optionally use the following line to get timestamps in WPP log entries
recorderConfigure.UseTimeStamp    = WppRecorderTrue;
// Use this line if you would like more precise timestamps (ten millionths of a second). This is valid only if you have set UseTimeStamp = WppRecorderTrue.
// recorderConfigure.PreciseTimeStamp = WppRecorderTrue
status = WppRecorderConfigure(&recorderConfigure);

For more info about timestamps in WPP log entries including sample log output, see Inflight Trace Recorder (IFR) for logging traces.

Requirements

Requirement Value
Target Platform Windows
Header wpprecorder.h