Trace String APIs

Functions
traceResult	xTraceStringRegister (const char *szString, TraceStringHandle_t *pString)
	Registers a trace string.
TraceStringHandle_t	xTraceRegisterString (const char *name)
	Registers a trace string.

Detailed Description

Function Documentation

xTraceRegisterString()

TraceStringHandle_t xTraceRegisterString

(

const char *

name

)

Registers a trace string.

Deprecated

Remains for backward compability with pre v4.6 versions of the recorder.

Parameters

[in]

name

Name.

Returns

TraceStringHandle_t

xTraceStringRegister()

traceResult xTraceStringRegister	(	const char *	szString,
		TraceStringHandle_t *	pString )

Registers a trace string.

This routine registers a strings in the recorder, e.g. for names of user event channels.

Example: TraceStringHandle_t myEventHandle; xTraceStringRegister("MyUserEvent", &myEventHandle); ... xTracePrintF(myEventHandle, "My value is: %d", myValue);

Parameters

[in]	szString	String.
[out]	pString	Pointer to uninitialized trace string.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success