RxLogEventWithBufferDirect function (rxprocs.h)

Article
02/22/2024

RxLogEventWithBufferDirect allocates an I/O error log structure, fills it in with information, and writes the entry to the I/O error log.

Syntax

void RxLogEventWithBufferDirect(
       IN PVOID           DeviceOrDriverObject,
  [in] IN PUNICODE_STRING OriginatorId,
  [in] IN ULONG           EventId,
  [in] IN NTSTATUS        Status,
  [in] IN PVOID           DataBuffer,
  [in] IN USHORT          DataBufferLength,
  [in] IN ULONG           LineNumber
);

Parameters

DeviceOrDriverObject

A pointer to the RDBSS device object.

[in] OriginatorId

The string indicating the caller generating the error.

[in] EventId

The value indicating the I/O error log code which is different than an NTSTATUS value returned by a routine. The legal I/O error log code values are defined in the ntiolog.h header file included with the Microsoft Windows SDK and Visual Studio.

[in] Status

The value indicating the status code of a routine indicating a failure.

[in] DataBuffer

A pointer to a data buffer to be added to the I/O error log structure.

[in] DataBufferLength

The length of the data buffer to be added to the I/O error log structure.

[in] LineNumber

The line number in the source code file where this failure occurred.

Return value

None

Remarks

RxLogEventDirect internally calls the RxLogEventWithAnnotation routine to create and write the log entry passing the Status and LineNumber parameters as the Annotations parameter to RxLogEventWithAnnotation.

The I/O error log entry size is limited to a length of 255 characters. So if the combined length of the EventId, DataBuffer, and Annotations parameters plus the size of the fixed part of the I/O error log entry exceeds 255, then no I/O error log entry will be created.

The RxLogEventWithAnnotation routine needs to allocate memory in order to create the I/O error log entry . Consequently, RxLogEventWithBufferDirect can silently fail if the memory allocation fails.

Requirements

Requirement	Value
Target Platform	Desktop
Header	rxprocs.h (include Rxprocs.h, Rxstruc.h)
IRQL	<= APC_LEVEL