1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150
|
<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 3//EN">
<HTML><HEAD>
<TITLE>IBM Visualization Data Explorer Programmer's Reference</TITLE>
<META HTTP-EQUIV="abstract" CONTENT="IBM Visualization Data Explorer
Programmer's Reference">
<META HTTP-EQUIV="contact" CONTENT="IBM Visualization Data Explorer
(ibmdx@watson.ibm.com)">
<META HTTP-EQUIV="owner" CONTENT="IBM Visualization Data Explorer
(ibmdx@watson.ibm.com)">
<META HTTP-EQUIV="updated" CONTENT="Tue, 16 Sep 1997 ">
<META HTTP-EQUIV="review" CONTENT="Fri, 14 Aug 1998 ">
<META HTTP-EQUIV="keywords" CONTENT="GRAPHICS VISUALIZATION VISUAL PROGRAM DATA
MINING">
<meta http-equiv="content-type" content="text/html;charset=ISO-8859-1">
</HEAD><BODY BGCOLOR="#FFFFFF">
<A NAME="Top_Of_Page"></A>
<H1>IBM Visualization Data Explorer Programmer's Reference</H1>
<B>[ <A HREF="#Bot_Of_Page">Bottom of Page</A> | <A
HREF="progu128.htm">Previous Page</A> | <A HREF="progu130.htm">Next
Page</A> | <A HREF="../proguide.htm#ToC">Table of Contents</A> | <A
HREF="progu097.htm#PToC20">Partial Table of Contents</A> | <A
HREF="progu344.htm#HDRINDEX_START">Index</A> ]</B><HR><P>
<H3><A NAME="HDRDXDB" HREF="progu097.htm#PToC_223">DXDebug, DXEnableDebug,
DXQueryDebug</A></H3>
<A NAME="IDX1628"></A>
<A NAME="IDX1629"></A>
<A NAME="IDX1630"></A>
<A NAME="IDX1631"></A>
<A NAME="IDX1632"></A>
<A NAME="IDX1633"></A>
<P><STRONG>Function</STRONG>
<P>
Perform operations on global debug keys.
<P><STRONG>Syntax</STRONG>
<BR>
<TT><STRONG><BR>
#include <dx/dx.h><BR>
<P><BR>
void DXDebug(char *classes, char *message, ...)<BR>
void DXEnableDebug(char *classes, int enable)<BR>
int DXQueryDebug(char *classes)<BR>
</STRONG></TT><BR>
<P><STRONG>Functional Details</STRONG>
<P>
<TT><STRONG>DXDebug</STRONG></TT> compares the array of 1-character keys in
<TT><STRONG>classes</STRONG></TT> to the set of keys that have been
enabled with <TT><STRONG>DXEnableDebug</STRONG></TT>.
If it finds a match, <TT><STRONG>DXDebug</STRONG></TT> calls
<TT><STRONG>DXMessage</STRONG></TT> with
<TT><STRONG>message</STRONG></TT> and
any parameters that follow
<TT><STRONG>message</STRONG></TT>.
<P>
<TT><STRONG>DXEnableDebug</STRONG></TT> enables or disables
(<TT><STRONG>enable</STRONG></TT> = 1 or 0, respectively)
the global key corresponding to each key in the
array of 1-character <TT><STRONG>keys</STRONG></TT>.
Usually, this routine is not called directly but is accessed at run time
by calling the <TT><STRONG>Trace</STRONG></TT> module
(see <I>IBM Visualization Data Explorer User's Reference</I>).
<P>
<TT><STRONG>DXQueryDebug</STRONG></TT> compares the array of 1-character
<TT><STRONG>keys</STRONG></TT> to the set of keys that have been
enabled with <TT><STRONG>DXEnableDebug</STRONG></TT>.
It returns 1 if any key matches; otherwise, it returns 0.
<TABLE><TR><TD ALIGN="LEFT" VALIGN="TOP"><B>Note:</B></TD><TD ALIGN="LEFT"
VALIGN="TOP">The upper-case letters A-Z and the numbers 0-9 are
reserved for system use.
Module writers may use the lowercase letters a-z.
</td></tr></table>
<P>
Example: If the module code for <TT><STRONG>MyModule()</STRONG></TT>
contained the following lines:
<PRE>
DXDebug("aqr", "the value of the index is %d",i);
DXDebug("ar", "the last value was %d", last);
DXDebug("asq", "entering for loop");
DXDebug("a", "function foo() returned an error ");
</PRE>
<P>
Then after executing the following modules:
<BR>
<TT><BR>
Trace("q",1);<BR>
MyModule();<BR>
</TT><BR>
<P>
Messages 1 and 3 would be printed.
<P>
If the following modules are then
executed:
<BR>
<TT><BR>
Trace("r",1);<BR>
MyModule();<BR>
</TT><BR>
<P>
Messages 1, 2, and 3 would be printed, since both
"q" and "r" are now
enabled.
<P>
If the following modules were then executed:
<BR>
<TT><BR>
Trace("qr",0);<BR>
MyModule();<BR>
</TT><BR>
<P>
None of the messages would be printed, as "a," "q," "s,"
and "r" are now all disabled.
<P>
Messages are printed using the
<TT><STRONG>DXMessage</STRONG></TT> function (see <A
HREF="progu242.htm#HDRDXMESS">DXMessage</A>).
<P><STRONG>Return Value</STRONG>
<P>
<TT><STRONG>DXDebug</STRONG></TT> and <TT><STRONG>DXEnableDebug</STRONG></TT>
have no return value.
<TT><STRONG>DXQueryDebug</STRONG></TT> returns 0 or 1.
<P><STRONG>See Also</STRONG>
<P>
<TT><STRONG>
<A HREF="progu242.htm#HDRDXMESS">DXMessage</A>
</STRONG></TT>
<P>
<A HREF="progu055.htm#HDRERRSEC">13.1 , "Error Handling and Messages"</A>.
<P><HR><B>[ <A HREF="#Top_Of_Page">Top of Page</A> | <A
HREF="progu128.htm">Previous Page</A> | <A HREF="progu130.htm">Next
Page</A> | <A HREF="../proguide.htm#ToC">Table of Contents</A> | <A
HREF="progu097.htm#PToC20">Partial Table of Contents</A> | <A
HREF="progu344.htm#HDRINDEX_START">Index</A> ]</B> <br><b>[<a
href="../allguide.htm">Data Explorer Documentation</a> | <a
href="../qikguide.htm">QuickStart Guide</a> | <a
href="../usrguide.htm">User's Guide</a> | <a
href="../refguide.htm">User's Reference</a> | <a
href="../proguide.htm">Programmer's Reference</a> | <a
href="../insguide.htm">Installation and Configuration
Guide</a> ]</b><br><p><b>[<a
href="http://www.research.ibm.com/dx">Data Explorer Home
Page</a>]</b><p><HR ALIGN=LEFT WIDTH=600><b>[<A
HREF="http://www.ibm.com/">IBM Home Page</A> | <A
HREF="http://www.ibm.com/Orders/">Order</A> | <A
HREF="http://www.ibm.com/Search/">Search</A> | <A
HREF="http://www.ibm.com/Assist/">Contact IBM</A> | <A
HREF="http://www.ibm.com/Legal/">Legal</A> ]</b><hr><p>
<A NAME="Bot_Of_Page"></A>
</BODY></HTML>
|