TraceDumpEx

[This is preliminary documentation and subject to change.]

The TraceDumpEx function outputs a hexadecimal dump of size dwByteCount. TraceDumpEx differentiates itself from TraceDump in its extended (Ex) output options, implemented through the use of non-zero dwFlags values. Output from TraceDumpEx can include information with a prefix of 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 TraceDumpEx(
  IN DWORD dwTraceID,
  IN DWORD dwFlags OPTIONAL,
  IN LPBYTE lpbBytes,
  IN DWORD dwByteCount,
  IN DWORD dwGroupSize,
  IN BOOL bAddressPrefix,
  IN LPCTSTR lpszPrefix  
);
 

Parameters

dwTraceID

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

dwFlags

Flags that control appearance of TraceDumpEx output. Ensure dwFlags is one or more of the following:

TRACE_NO_STDINFO

Suppresses output of the standard information associated with dwTraceID.

TRACE_USE_MASK

Determines whether file and/or console output will be generated by comparing the high-order word of dwFlags against registry values FileTracingMask and ConsoleTracingMask.

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 is prefixed with its memory address. 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

TraceDumpEx 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

TraceDump, TraceRegisterEx, TraceDeregisterEx, TracePrintfEx, TraceVprintfEx, TracePutsEx, GetLastError