Miles Sound System SDK 7.2a

AIL_register_trace_callback

The function AIL_register_trace_callback registers an application function to receive debug trace message traffic from MSS.

AILTRACECB AIL_register_trace_callback(
  AILTRACECB callback,
  S32 level
);

In Parameters

callback: should be set to the address of an application function prototyped as an AILTRACECB callback.
level: specifies whether only application calls to Miles (1), application calls plus any resulting internal calls to Miles functions (2), or no calls at all (0) are reported to the trace callback.

Returns

The address of the previously-installed debug trace function handler.

Discussion

This function is intended primarily for use in diagnostic work. It provides a single convenient hook point that a Miles application can use to inspect its own calls to the system, and (optionally) any further calls to MSS that are made internally in the course of executing a given Miles function.

The ASCII text traffic which will be passed to the AILTRACECB callback function may consist of indenting whitespace, timestamps and other marker/decorative characters as well as function names, parameters, and return values.

Most applications that use AIL_register_trace_callback should pass 1 as the level parameter, to avoid excessive output-text clutter due to nested calls.

Background function calls (those made while Miles is executing from its own internal thread(s) or interrupt handlers) will not be reported to the trace callback.

AIL_startup must be called prior to registering a debug trace callback.

Group: System Services
Related Sections: Call Logging under DOS, Call Logging under MacOS, Call Logging under Nintendo, Call Logging under PlayStation 2, Call Logging under PlayStation 3, Call Logging under Win32, Call Logging under Win64, Call Logging under Xbox, Call Logging under Xbox 360
Related Functions: AILTRACECB, AIL_register_trace_callback, AIL_startup
Related Basic Types: S32