PreviousNext

DCE_SVC_DEBUG(3dce)

Macro to output a serviceability debug message

Synopsis

#include <dce/dce.h>

DCE_SVC_DEBUG((

dce_svc_handle_t handle,
const unsigned32 table_index,
unsigned32 debug_level,
char * format,
..));

Parameters

Input

handle
The caller's serviceability handle.

table_index
The message's sub-component name (defined in the sams file).

debug_level
Serviceability debug level for the message.

format
The message string.

. . .
Format arguments, if any.

Description
The DCE_SVC_DEBUG macro is used to generate debugging output. Because it is a macro that takes a variable number of arguments, the entire parameter list must be enclosed in two sets of parentheses. The handle and table_index parameters are as described for dce_svc_printf( ).

In contrast to the normal operation of the serviceability interface, DCE_SVC_DEBUG requires the caller to specify the message as a string literal in the call, rather than by defining it in the application's sams file specifying the message by a message ID.

The debug_level argument indicates the level of detail associated with this message and must be in the range svc_c_debug1 to svc_c_debug9.

Thus the value of debug_level associates the message with one of nine "levels'', and whether or not the message is actually generated at run time will depend on what debugging level has been set for the application. The level can be set by the application itself (by a call to dce_svc_debug_set_levels( ) or dce_svc_debug_routing( )) or by the value of an environment variable or a serviceability routing file; see svcroute(5dce) for further information.

The significance of the various levels is application-defined, but in general the higher levels (numbers) imply more detail in debugging output.

The format and . . . parameters are passed directly to fprintf( ) or its equivalent.

Related Information
Functions: dce_svc_debug_routing(3dce)

dce_svc_debug_set_levels(3dce)

dce_svc_printf(3dce)

dce_svc_routing(3dce)

Files: svcroute(5dce)