TraceDump

[This is preliminary documentation and subject to change.]

The TraceDump function outputs a hexadecimal dump of size dwByteCount, prefixed with the name associated with the calling service or application's dwTraceID, the associated Thread identifier used with the RRAS tracing functionality, the current system time, and a brief description of the dump.

DWORD TraceDump(
  IN DWORD dwTraceID,     //handle from initial TraceRegister call
  IN LPBYTE lpbBytes,     //pointer to dump buffer
  IN DWORD dwByteCount,   //number of bytes to dump
  IN DWORD dwGroupSize,   //size of byte grouping (1,2 or4)
  IN BOOL bAddressPrefix,  //include memory address toggle
  IN LPCTSTR lpszPrefix   //prefix
);
 

Parameters

dwTraceID

The handle returned by the calling service or application's initial TraceRegister call.

lpbBytes

A pointer to the buffer from which the hex dump is to be generated

dwByteCount

The number of bytes to dump from the buffer.

dwGroupSize

The output's byte grouping size. Valid values are 1, 2, or 4.

bAddressPrefix

Boolean value that determines whether each line of the hex dump has its memory address as a prefix. A value of TRUE includes the memory address.

lpszPrefix

Pointer to the prefix.

Return Values

Successful execution of TraceDump returns the number of characters output.

Otherwise, TraceDump returns zero. Call GetLastError to get the error code.

Remarks

TraceDump generates debug style dumps, with the byte-ordering dependent on the processor's endian setting. Also note that the last line of the dump is padded with zeroes.

QuickInfo

  Windows NT: Use version 5.0 and later.
  Windows: Unsupported.
  Windows CE: Unsupported.
  Header: Declared in rtutils.h.
  Import Library: Link with rtutils.lib.

See Also

TraceDumpEx, TraceRegister, TraceDeregister, TracePrintf, TraceVprintf, TracePuts, GetLastError