TraceDump

[This Tracing API is available for use in the operating systems listed in the Requirements section. It may be altered or unavailable in subsequent versions. Instead use the Event Tracing API.]

The Tracing API has been superseded but is still available on older platforms.

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(
  DWORD dwTraceID,
  LPBYTE lpbBytes,
  DWORD dwByteCount,
  DWORD dwGroupSize,
  BOOL bAddressPrefix,
  LPCTSTR lpszPrefix
);

Parameters

• dwTraceID
  [in] Handle returned by the calling service or application's initial TraceRegister call.
• lpbBytes
  [in] Pointer to the buffer from which the hex dump is to be generated
• dwByteCount
  [in] Specifies the number of bytes to dump from the buffer.
• dwGroupSize
  [in] Specifies the byte grouping size of the output. Valid values are 1, 2, or 4.
• bAddressPrefix
  [in] Specifies the 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
  [in] Pointer to the prefix.

Return Value

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. The byte ordering of the dump is dependent on the type of processor. Also note that the last line of the dump is padded with zeroes.

Requirements

See Also

About Tracing
Tracing Reference
TraceDumpEx
TraceRegister
TraceDeregister
TracePrintf
TraceVprintf
TracePuts