_RxLog function (rxlog.h)

_RxLog takes a format string and variable number of parameters and formats an output string for recording as an I/O error log entry if logging is enabled.

Syntax

void _RxLog(
  PCSTR format,
  ...   
);

Parameters

format

The variable argument list that contains a format string and a variable number of parameters.

...

TBD

Return value

None

Remarks

It is recommended that the RxLog macro be used instead of calling the _RxLog routine directly.

If logging is enabled, _RxLog will output a string for recording as an I/O error log entry based on the format string and number of variables passed.

The _RxLog routine supports the following format string descriptors:

%lN, %wN, %lS, %wS, %ld, %wd--a number

%x--a hexadecimal number

%c--a character

%s--an ASCII string

%Z--a Unicode string that contains ASCII characters

The _RxLog routine is limited to an output string of, at most, 48 lines, so the Format string cannot contain more than 48 '\n' characters.

It is recommended that the RxLog macro be used to call this routine. On checked builds, the RxLog macro will call the _RxLog routine. On retail builds, the RxLog macro is defined to nothing.

Requirements

See also

RxLogEventDirect

RxLogEventWithAnnotation

RxLogEventWithBufferDirect