Share via


TraceVprintfEx

[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.]

Functionality of TraceVprintfEx is very similar to that of TracePrintfEx, except that it takes a prepared variable argument list as its third variable. TraceVprintfEx differentiates itself from TraceVprintf in its ability to customize output through the use of non-zero flags. See TracePrintfEx for more information.

DWORD TraceVprintfEx(
  DWORD dwTraceID,
  DWORD dwFlags,
  LPCTSTR lpszFormat,
  va_list arglist
);

Parameters

  • dwTraceID
    [in] Handle returned by the calling service or application's initial TraceRegister call.

  • dwFlags
    [in] Specifies the flags that control appearance of TraceVprintfEx output. Ensure dwFlags is one or more of the following:

    Flag Meaning
    TRACE_NO_STDINFO Suppresses output of the standard information associated with dwTraceID.
    TRACE_USE_MASK Determines whether file and/or console output is generated by comparing the high-order word of dwFlags against registry values FileTracingMask and ConsoleTracingMask.
    TRACE_USE_MSEC Reports the time with millisecond accuracy.
  • lpszFormat
    [in] Pointer to a null-terminated string that contains format control information. For more information, see the Remarks section of the wsprintf function.

  • arglist
    [in] Specifies the prepared list of arguments that define the format of TraceVprintf output.

Return Value

If the function is successful, TraceVprintfEx returns the number of characters output, excluding the terminating null-character.

If the function fails, the return value is zero. This may indicate that tracing is disabled in the registry. See Tracing Configuration for more information.

Requirements

Server Requires Windows Server 2003 or Windows 2000 Server.
Redistributable Requires RRAS download on Windows NT Server 4.0 SP3 and later.
Header

Declared in Rtutils.h.

Library

Use Rtutils.lib.

DLL Requires Rtutils.dll.
Unicode

Implemented as TraceVprintfExW (Unicode) and TraceVprintfExA (ANSI).

See Also

About Tracing
Tracing Reference
TraceVprintf
TraceRegisterEx
TracePrintfEx
TracePutsEx
TraceDumpEx