root/WizardsToolkit/trunk/www/api/log.html

Revision 813, 11.4 KB (checked in by cristy, 3 months ago)
Line 
1<?xml version="1.0" encoding="UTF-8"?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">
4<head>
5  <style type="text/css"><!--
6    @import url("../../www/wizard.css");
7  //--></style>
8  <title>Wizard's Toolkit: C API for the Wizard's Toolkit: Log Events</title>
9  <meta http-equiv="Content-Language" content="en-US"/>
10  <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
11  <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
12  <meta name="Generator" content="PHP"/>
13  <meta name="Keywords" content="c, api, for, the, wizard's, toolkit:, log, events, WizardsToolkit, Wizard's, Toolkit"/>
14  <meta name="Description" content="The Wizard's Toolkit, version 1.0.2, is a free C API that includes a number of methods most developers will find useful in their projects."/>
15  <meta name="Rating" content="INDEX, FOLLOW"/>
16  <meta name="Robots" content="ALL"/>
17  <meta name="Generator" content="ImageMagick Studio LLC"/>
18  <meta name="Author" content="ImageMagick Studio LLC"/>
19  <meta name="Revisit-after" content="2 DAYS"/>
20  <meta name="Resource-type" content="document"/>
21  <meta name="Copyright" content="Copyright (c) 1999-2009 ImageMagick Studio LLC"/>
22  <meta name="Distribution" content="Global"/>
23  <link rel="shortcut icon" href="../../images/wand.ico"  type="images/vnd.microsoft.icon"/>
24</head>
25
26<body id="www-wizards-toolkit.org">
27  <table id="titlebar" style="width: 100%;background-color: #f5f5f5" cellpadding="0" cellspacing="0" border="0" summary="Wizard's Toolkit">
28    <tbody>
29      <tr valign="top">
30        <td align="left"><a href="../../index.html"><img id="titlebar-west" src="../../images/script.png" alt="[Wizard's Toolkit]" width="400" height="60" border="0" vspace="28" name="titlebar-west" /></a></td>
31        <td align="left"><a href="http://www.wizards-toolkit.org/" target="1756039235"><img id="titlebar-west" src="../../images/sponsor.jpg" alt="[sponsor]" border="0" vspace="28" name="titlebar-west" /></a></td>
32        <td width="99%"><br /></td>
33        <td style="background-color: white" align="right"><a href="../../index.html"><img src="../../images/sprite.jpg" alt="" width="114" height="118" border="0" name="titlebar-east" /></a></td>
34        <td style="background-color: white" align="right"><a href="http://www.wizards-toolkit.org/discourse-server/viewforum.html?f=17" target="1050304089"><img id="titlebar-east" src="../../images/logo.jpg" alt="" width="114" height="118" border="0" name="titlebar-east" /></a></td>
35      </tr>
36    </tbody>
37  </table>
38
39  <table style="width: 100%" border="0" cellpadding="0" cellspacing="0" summary="">
40  <tbody>
41
42    <tr valign="top" style="height: 100%;">
43      <td id="menu" width="1%" height="100%">
44      <p><a href="#main">Skip to page contents</a></p>
45       <font size="-1">
46      <span>[</span>
47      <a href="../../index.html">About the<br />Wizard's Toolkit</a>
48  <span>]</span><br /><span>[</span>
49      <a href="../../www/command-line-tools.html">Command-line Tools</a>
50  <span>]</span><br /><span>[</span>
51      <a href="../../www/api.html">Application Program<br />Interface</a>
52  <span>]</span><br /><span>[</span>
53      <a href="../../www/install-source.html">Install from Source</a>
54      <a href="../../www/install-source.html#unix" class="sub">Unix</a>
55      <a href="../../www/install-source.html#windows" class="sub">Windows</a>
56      <a href="../../www/binary-releases.html">Binary Releases</a>
57      <a href="../../www/binary-releases.html#unix" class="sub">Unix</a>
58      <a href="../../www/binary-releases.html#windows" class="sub">Windows</a>
59  <span>]</span><br /><span>[</span>
60      <a href="../../www/download.html">Download</a>
61  <span>]</span><br /><span>[</span>
62<div class="menu">
63  <a href="../../www/sponsors.html">Sponsors:</a>
64
65<div class="sponsbox">
66<div  class="sponsor">
67  <a href="http://www.tomsgutscheine.de">Tom's Gutscheine</a><!-- 201005010360 invendio.de-->
68</div>
69</div>
70</div>
71      <span>]</span>
72      </font>
73      </td>
74
75      <td id="main" valign="top">
76<p class="navigation-index">[<a href="#CloseWizardLog">CloseWizardLog</a> &bull; <a href="#GetLogInfoList">GetLogInfoList</a> &bull; <a href="#GetLogList">GetLogList</a> &bull; <a href="#GetLogName">GetLogName</a> &bull; <a href="#IsEventLogging">IsEventLogging</a> &bull; <a href="#ListLogInfo">ListLogInfo</a> &bull; <a href="#LogWizardEvent">LogWizardEvent</a> &bull; <a href="#LoadLogLists">LoadLogLists</a> &bull; <a href="#SetLogEventMask">SetLogEventMask</a> &bull; <a href="#SetLogFormat">SetLogFormat</a> &bull; <a href="#SetLogName">SetLogName</a>]</p>
77
78<h2><a href="http://www.wizards-toolkit.org/api/WizardsToolkit/log
79_8c.html" target="source" name="CloseWizardLog">CloseWizardLog</a></h2>
80<div class="doc-section">
81
82<p>CloseWizardLog() closes the Wizard log.</p></ol>
83
84<p>The format of the CloseWizardLog method is:</p>
85
86<pre class="code">
87  CloseWizardLog(void)
88</pre>
89
90 </div>
91<h2><a href="http://www.wizards-toolkit.org/api/WizardsToolkit/log
92_8c.html" target="source" name="GetLogInfoList">GetLogInfoList</a></h2>
93<div class="doc-section">
94
95<p>GetLogInfoList() returns any logs that match the specified pattern.</p></ol>
96
97<p>The format of the GetLogInfoList function is:</p>
98
99<pre class="text">
100  const LogInfo **GetLogInfoList(const char *pattern,
101    unsigned long *number_preferences,ExceptionInfo *exception)
102</pre>
103
104<p>A description of each parameter follows:</p></ol>
105
106<h5>pattern</h5>
107<ol><p>Specifies a pointer to a text string containing a pattern.</p></ol>
108
109<h5>number_preferences</h5>
110<ol><p>This integer returns the number of logs in the list.</p></ol>
111
112<h5>exception</h5>
113<ol><p>Return any errors or warnings in this structure.</p></ol>
114
115 </div>
116<h2><a href="http://www.wizards-toolkit.org/api/WizardsToolkit/log
117_8c.html" target="source" name="GetLogList">GetLogList</a></h2>
118<div class="doc-section">
119
120<p>GetLogList() returns any logs that match the specified pattern.</p></ol>
121
122<p>The format of the GetLogList function is:</p>
123
124<pre class="text">
125  char **GetLogList(const char *pattern,unsigned long *number_preferences,
126    ExceptionInfo *exception)
127</pre>
128
129<p>A description of each parameter follows:</p></ol>
130
131<h5>pattern</h5>
132<ol><p>Specifies a pointer to a text string containing a pattern.</p></ol>
133
134<h5>number_preferences</h5>
135<ol><p>This integer returns the number of logs in the list.</p></ol>
136
137<h5>exception</h5>
138<ol><p>Return any errors or warnings in this structure.</p></ol>
139
140 </div>
141<h2><a href="http://www.wizards-toolkit.org/api/WizardsToolkit/log
142_8c.html" target="source" name="GetLogName">GetLogName</a></h2>
143<div class="doc-section">
144
145<p>GetLogName() returns the current log name.</p></ol>
146
147<p>The format of the GetLogName method is:</p>
148
149<pre class="code">
150  const char *GetLogName(void)
151</pre>
152
153 </div>
154<h2><a href="http://www.wizards-toolkit.org/api/WizardsToolkit/log
155_8c.html" target="source" name="IsEventLogging">IsEventLogging</a></h2>
156<div class="doc-section">
157
158<p>IsEventLogging() returns WizardTrue if debug of events is enabled otherwise WizardFalse.</p></ol>
159
160<p>The format of the IsEventLogging method is:</p>
161
162<pre class="code">
163  WizardBooleanType IsEventLogging(void)
164</pre>
165
166 </div>
167<h2><a href="http://www.wizards-toolkit.org/api/WizardsToolkit/log
168_8c.html" target="source" name="ListLogInfo">ListLogInfo</a></h2>
169<div class="doc-section">
170
171<p>ListLogInfo() lists the log info to a file.</p></ol>
172
173<p>The format of the ListLogInfo method is:</p>
174
175<pre class="code">
176  WizardBooleanType ListLogInfo(FILE *file,ExceptionInfo *exception)
177</pre>
178
179<p>A description of each parameter follows.</p></ol>
180
181<h5>file</h5>
182<ol><p>An pointer to a FILE.</p></ol>
183
184<h5>exception</h5>
185<ol><p>Return any errors or warnings in this structure.</p></ol>
186
187 </div>
188<h2><a href="http://www.wizards-toolkit.org/api/WizardsToolkit/log
189_8c.html" target="source" name="LogWizardEvent">LogWizardEvent</a></h2>
190<div class="doc-section">
191
192<p>LogWizardEvent() logs an event as determined by the log configuration file. If an error occurs, WizardFalse is returned otherwise WizardTrue.</p></ol>
193
194<p>The format of the LogWizardEvent method is:</p>
195
196<pre class="code">
197  WizardBooleanType LogWizardEvent(const LogEventType type,
198    const char *module,const char *function,const unsigned long line,
199    const char *format,...)
200</pre>
201
202<p>A description of each parameter follows:</p></ol>
203
204<h5>type</h5>
205<ol><p>The event type.</p></ol>
206
207<h5>filename</h5>
208<ol><p>The source module filename.</p></ol>
209
210<h5>function</h5>
211<ol><p>The function name.</p></ol>
212
213<h5>line</h5>
214<ol><p>The line number of the source module.</p></ol>
215
216<h5>format</h5>
217<ol><p>The output format.</p></ol>
218
219 </div>
220<h2><a href="http://www.wizards-toolkit.org/api/WizardsToolkit/log
221_8c.html" target="source" name="LoadLogLists">LoadLogLists</a></h2>
222<div class="doc-section">
223
224<p>LoadLogLists() loads one or more log configuration file which provides a mapping between log attributes and log name.</p></ol>
225
226<p>The format of the LoadLogLists method is:</p>
227
228<pre class="code">
229  WizardBooleanType LoadLogLists(const char *filename,
230    ExceptionInfo *exception)
231</pre>
232
233<p>A description of each parameter follows:</p></ol>
234
235<h5>filename</h5>
236<ol><p>The log configuration filename.</p></ol>
237
238<h5>exception</h5>
239<ol><p>Return any errors or warnings in this structure.</p></ol>
240
241 </div>
242<h2><a href="http://www.wizards-toolkit.org/api/WizardsToolkit/log
243_8c.html" target="source" name="SetLogEventMask">SetLogEventMask</a></h2>
244<div class="doc-section">
245
246<p>SetLogEventMask() accepts a list that determines which events to log.  All other events are ignored.  By default, no debug is enabled.  This method returns the previous log event mask.</p></ol>
247
248<p>The format of the SetLogEventMask method is:</p>
249
250<pre class="code">
251  LogEventType SetLogEventMask(const char *events)
252</pre>
253
254<p>A description of each parameter follows:</p></ol>
255
256<h5>events</h5>
257<ol><p>log these events.</p></ol>
258
259 </div>
260<h2><a href="http://www.wizards-toolkit.org/api/WizardsToolkit/log
261_8c.html" target="source" name="SetLogFormat">SetLogFormat</a></h2>
262<div class="doc-section">
263
264<p>SetLogFormat() sets the format for the "human readable" log record.</p></ol>
265
266<p>The format of the LogWizardFormat method is:</p>
267
268<pre class="code">
269  SetLogFormat(const char *format)
270</pre>
271
272<p>A description of each parameter follows:</p></ol>
273
274<h5>format</h5>
275<ol><p>The log record format.</p></ol>
276
277 </div>
278<h2><a href="http://www.wizards-toolkit.org/api/WizardsToolkit/log
279_8c.html" target="source" name="SetLogName">SetLogName</a></h2>
280<div class="doc-section">
281
282<p>SetLogName() sets the log name and returns it.</p></ol>
283
284<p>The format of the SetLogName method is:</p>
285
286<pre class="code">
287  const char *SetLogName(const char *name)
288</pre>
289
290<p>A description of each parameter follows:</p></ol>
291
292<h5>log_name</h5>
293<ol><p>SetLogName() returns the current client name.</p></ol>
294
295<h5>name</h5>
296<ol><p>Specifies the new client name.</p></ol>
297
298 </div>
299      </td>
300      <td id="margin" width="1%" height="100%" valign="top" align="right">&nbsp;</td>
301    </tr>
302  </tbody>
303  </table>
304  <div id="linkbar">
305    <a href="http://www.wizards-toolkit.org/discourse-server/viewforum.html?f=17" target="78290502">Discourse Server</a> |
306    <a href="../../www/license.html">License</a> |
307    <a href="../../www/notice.html">Notice</a>
308  </div>
309  <div id="footer">
310    <span id="footer-west">&copy; 1999-2009 ImageMagick Studio LLC</span>
311  </div>
312  <div style="clear: both; margin: 0; width: 100%; "></div>
313</body>
314</html>
Note: See TracBrowser for help on using the browser.