DOC HOME SITE MAP MAN PAGES GNU INFO SEARCH PRINT BOOK
 

udi_debug_printf(3udi)


Output a debugging message

SYNOPSIS

#include <udi.h>

void udi_debug_printf (

	const char *format,

	... );
 

ARGUMENTS format is the format string, which controls the formatting of the output string, as described for udi_snprintf.

... are the remaining arguments, which provide the values used for the formatting codes.

description The udi_debug_printf function is intended for use in driver debugging, as a simplified alternative to the pair of udi_snprintf and udi_trace_write, in cases where the output is not needed in production environments. It is expected that udi_debug_printf calls would typically not appear in a (compiled) production driver.

Where required by this or other UDI specifications to trace or log events, drivers must use udi_trace_write or udi_log_write instead of udi_debug_printf, since udi_debug_printf may be a no-op in some environments. Use of udi_debug_printf may impair driver or system performance.

Environments may choose to ignore any or all calls to udi_debug_printf. Some environments may have different operational modes (e.g. debug mode vs. non-debug mode) that treat udi_debug_printf differently. Environments intended to facilitate driver debugging should include at least an option to enable output from udi_debug_printf calls. All environments must at least provide the udi_debug_printf function, even if it does nothing.

Output from udi_debug_printf, if any, will be sent to an environment implementation-defined device, file, or application. Newline (`\n') characters in the format string or any string or character arguments will be translated to an appropriate end of line character(s); other control characters must not be used. Output from each call to udi_debug_printf may be truncated to 99 bytes of text. Note that if the output is truncated, any terminating newline character may have been discarded.


UDI Core Specification Contents