root/WizardsToolkit/trunk/www/api.html

Revision 1, 8.7 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: Application Program Interfaces</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="application, program, interfaces, 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="1113599456"><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="1904233029"><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      <a href="../www/sponsors.html">Sponsors:</a>
63      <fieldset>
64  <a href="http://www.anxietyspinnerrings.com" class="sponsor" target="sponsor">Silver Rings</a><!-- 200904010140 -->
65<br />
66      </fieldset>
67      <span>]</span>
68      </font>
69      </td>
70
71      <td id="main" valign="top">
72<p>The <a href="../www/api/WizardsToolkit/index.html" target="1110932832">Wizard's Toolkit API</a>  is a low-level interface between the C programming language and the Toolkit's libraries.  A description of the public methods are found here:</p>
73
74<ul>
75  <li><a href="../www/api/aes.html">American Encryption Standard Methods</a></li>
76  <li><a href="../www/api/authenticate.html">Authentication Methods</a></li>
77  <li><a href="../www/api/blob.html">Binary Large OBjectS Methods</a></li>
78  <li><a href="../www/api/bzip.html">Bzip Entropy Methods</a></li>
79  <li><a href="../www/api/client.html">Client Methods</a></li>
80  <li><a href="../www/api/crc64.html">Cyclic Redunancy Checksum Methods</a></li>
81  <li><a href="../www/api/cipher.html">Secure Cipher Methods</a></li>
82  <li><a href="../www/api/entropy.html">Entropy Methods</a></li>
83  <li><a href="../www/api/exception.html">Exception Methods</a></li>
84  <li><a href="../www/api/file.html">File Methods</a></li>
85  <li><a href="../www/api/hash.html">Secure Hash Algorithm Methods</a></li>
86  <li><a href="../www/api/hashmap.html">Hash-map and Linked-list Methods</a></li>
87  <li><a href="../www/api/hmac.html">Keyed-Hashing for Message Authentication</a></li>
88  <li><a href="../www/api/key.html">Key Methods</a></li>
89  <li><a href="../www/api/keyring.html">Keyring Methods</a></li>
90  <li><a href="../www/api/log.html">Log Events</a></li>
91  <li><a href="../www/api/magick.html">Wizard Methods</a></li>
92  <li><a href="../www/api/md5.html">Message Digest Algorithm Methods</a></li>
93  <li><a href="../www/api/memory.html">Memory Allocation Methods</a></li>
94  <li><a href="../www/api/mime.html">Mime Methods</a></li>
95  <li><a href="../www/api/option.html">Option Methods</a></li>
96  <li><a href="../www/api/passphrase.html">Passphrase Methods</a></li>
97  <li><a href="../www/api/random.html">Random Numbers Methods</a></li>
98  <li><a href="../www/api/resource.html">Get/Set Resources</a></li>
99  <li><a href="../www/api/sanitize.html">Environment Sanitazion Methods</a></li>
100  <li><a href="../www/api/secret.html">Secret Authentication Methods</a></li>
101  <li><a href="../www/api/semaphore.html">Semaphore Methods</a></li>
102  <li><a href="../www/api/sha1.html">Secure Hash Algorithm-256 Methods</a></li>
103  <li><a href="../www/api/sha224.html">Secure Hash Algorithm-224 Methods</a></li>
104  <li><a href="../www/api/sha256.html">Secure Hash Algorithm-256 Methods</a></li>
105  <li><a href="../www/api/sha384.html">Secure Hash Algorithm-384 Methods</a></li>
106  <li><a href="../www/api/sha512.html">Secure Hash Algorithm-512 Methods</a></li>
107  <li><a href="../www/api/splay-tree.html">Self-adjusting Binary Tree Methods</a></li>
108  <li><a href="../www/api/serpent.html">Serpent Cipher Methods</a></li>
109  <li><a href="../www/api/string.html">String Methods</a></li>
110  <li><a href="../www/api/timer.html">Timing Methods</a></li>
111  <li><a href="../www/api/token.html">Token Methods</a></li>
112  <li><a href="../www/api/twofish.html">TwoFish Cipher Methods</a></li>
113  <li><a href="../www/api/version.html">Version Methods</a></li>
114  <li><a href="../www/api/xml-tree.html">XML Parser Methods</a></li>
115  <li><a href="../www/api/zip.html">Zip Entropy Methods</a></li>
116</ul>
117
118<p>After you write your Toolkit program, compile it like this:</p>
119
120<pre class="text">
121  cc `WizardsToolkit-config --cflags --cppflags` -o wizard wizard.c `WizardsToolkit-config --ldflags --libs`
122</pre>
123
124<p>Here is a example program that utilizes the Wizard's Toolkit API to get you started, <a href="../www/source/wizard.c">wizard.c</a>. It simply computes and prints the Secure Hash Algorithm 512-bit digest of a string.</p>
125
126<div class='viewport'>
127<pre class="code">
128  #include &lt;stdio.h>
129  #include &lt;wizard/WizardsToolkit.h>
130 
131  int main(int argc,char **argv)
132  {
133    HashInfo
134      *hash_info;
135 
136    StringInfo
137      *content;
138 
139    WizardsToolkitGenesis(*argv);
140    hash_info=AcquireHashInfo(SHA512Hash);
141    InitializeHash(hash_info);
142    content=StringToStringInfo("The Wizard's Toolkit");
143    UpdateHash(hash_info,content);
144    FinalizeHash(hash_info);
145    PrintStringInfo("Content",content);
146    PrintStringInfo("Digest",GetHashDigest(hash_info));
147    DestroyHashInfo(hash_info);
148    DestroyStringInfo(content);
149    WizardsToolkitTerminus();
150    return(0);
151  }
152</pre>
153</div>
154      </td>
155      <td id="margin" width="1%" height="100%" valign="top" align="right">&nbsp;</td>
156    </tr>
157  </tbody>
158  </table>
159  <div id="linkbar">
160    <a href="http://www.wizards-toolkit.org/discourse-server/viewforum.html?f=17" target="1899766240">Discourse Server</a> |
161    <a href="../www/license.html">License</a> |
162    <a href="../www/notice.html">Notice</a>
163  </div>
164  <div id="footer">
165    <span id="footer-west">&copy; 1999-2009 ImageMagick Studio LLC</span>
166  </div>
167  <div style="clear: both; margin: 0; width: 100%; "></div>
168</body>
169</html>
Note: See TracBrowser for help on using the browser.