blob: e3bf2bb5c08e40e5b231163fcfbdea33679245f5 [file] [log] [blame]
cristy3eaa0ef2010-03-06 20:35:26 +00001<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
cristy2c839602010-04-03 02:32:08 +00003<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">
cristy3eaa0ef2010-03-06 20:35:26 +00004<head>
cristy3c98a4f2010-08-13 20:09:41 +00005 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
6 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>
7 <title>ImageMagick: MagickCore, C API for ImageMagick: Read or Write Binary Large OBjects</title/>
cristy3ed852e2009-09-05 21:47:34 +00008 <meta http-equiv="Content-Language" content="en-US"/>
9 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
10 <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
cristy3c98a4f2010-08-13 20:09:41 +000011 <meta name="Application-name" content="ImageMagick"/>
12 <meta name="Description" content="ImageMagick® is a software suite to create, edit, and compose bitmap images. It can read, convert and write images in a variety of formats (about 100) including GIF, JPEG, JPEG-2000, PNG, PDF, PhotoCD, TIFF, and DPX. Use ImageMagick to translate, flip, mirror, rotate, scale, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bézier curves. ImageMagick is free software delivered as a ready-to-run binary distribution or as source code that you can freely use, copy, modify, and distribute. Its license is compatible with the GPL. It runs on all major operating systems. The functionality of ImageMagick is typically utilized from the command line or you can use the features from programs written in your favorite programming language. Choose from these interfaces: MagickCore (C), MagickWand (C), ChMagick (Ch), Magick++ (C++), JMagick (Java), L-Magick (Lisp), PascalMagick (Pascal), PerlMagick (Perl), MagickWand for PHP (PHP), PythonMagick (Python), RMagick (Ruby), or TclMagick (Tcl/TK). With a language interface, use ImageMagick to modify or create images automagically and dynamically."/>
13 <meta name="Application-url" content="http://www.imagemagick.org"/>
cristy3ed852e2009-09-05 21:47:34 +000014 <meta name="Generator" content="PHP"/>
15 <meta name="Keywords" content="magickcore, c, api, for, imagemagick:, read, or, write, binary, large, objects, ImageMagick, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject, Swiss, Army, Knife, Image, Processing"/>
cristy3ed852e2009-09-05 21:47:34 +000016 <meta name="Rating" content="GENERAL"/>
17 <meta name="Robots" content="INDEX, FOLLOW"/>
18 <meta name="Generator" content="ImageMagick Studio LLC"/>
19 <meta name="Author" content="ImageMagick Studio LLC"/>
20 <meta name="Revisit-after" content="2 DAYS"/>
21 <meta name="Resource-type" content="document"/>
cristy16af1cb2009-12-11 21:38:29 +000022 <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +000023 <meta name="Distribution" content="Global"/>
cristy3c98a4f2010-08-13 20:09:41 +000024 <link rel="icon" href="../../images/wand.png" sizes="32x32"/>
25 <link rel="shortcut icon" href="../../images/wand.ico" type="images/x-icon"/>
26 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
27 <style type="text/css" media="all">
28 @import url("../../www/magick.css");
29 </style>
cristy3eaa0ef2010-03-06 20:35:26 +000030</head>
31
32<body id="www-imagemagick-org">
33<div class="titlebar">
34<a href="../../index.html">
35 <img src="../../images/script.png" alt="[ImageMagick]"
36 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
37<a href="http://www.networkredux.com">
38 <img src="../../images/networkredux.png" alt="[sponsor]"
39 style="margin: 45px auto; border: 0px; float: left;" /></a>
40<a href="http://www.imagemagick.org/discourse-server/">
41 <img src="../../images/logo.jpg" alt=""
42 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
43<a href="../../index.html">
44 <img src="../../images/sprite.jpg" alt=""
45 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
46</div>
47
cristyce69bb02010-07-27 19:49:46 +000048<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +000049
cristy3ed852e2009-09-05 21:47:34 +000050<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000051 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +000052</div>
cristy3eaa0ef2010-03-06 20:35:26 +000053<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +000054<div class="menu">
cristybb503372010-05-27 20:51:26 +000055 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
56</div>
57<div class="sub">
58 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
59</div>
60<div class="sub">
61 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
62</div>
63<div class="sub">
64 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
65</div>
66<div class="sep"></div>
67<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000068 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +000069</div>
70<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000071 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +000072</div>
73<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000074 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +000075</div>
76<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000077 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +000078</div>
79<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000080 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +000081</div>
82<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000083 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +000084</div>
85<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000086 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +000087</div>
88<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000089 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +000090</div>
91<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000092 <a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +000093</div>
cristy3eaa0ef2010-03-06 20:35:26 +000094<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +000095<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000096 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +000097</div>
98<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000099 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000100</div>
101<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000102 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000103 </div>
104<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000105 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000106</div>
cristybb503372010-05-27 20:51:26 +0000107<div class="menu">
108 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
109</div>
cristy3ed852e2009-09-05 21:47:34 +0000110<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000111 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000112</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000113<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000114<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000115 <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000116</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000117<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000118<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000119 <a title="Site Map"href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000120</div>
121<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000122 <a title="Site Map: Links"href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000123</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000124<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000125<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000126 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000127
128<div class="sponsbox">
129<div class="sponsor">
cristy7d52cd62010-10-01 17:26:59 +0000130 <a title="Sponsor: Online-Magazin" href="http://www.unkostenbeitrag.de/">Online-Magazin</a><!-- 20101101000200 -->
131</div>
132<div class="sponsor">
133 <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
cristy73fd1cd2010-09-12 19:14:25 +0000134</div>
135<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000136 <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
137</div>
138<div class="sponsor">
cristy851dbce2010-08-06 21:40:00 +0000139 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
140</div>
141<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000142 <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
cristyc02484c2010-03-08 00:14:58 +0000143</div>
144<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000145 <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
cristy8f900122010-03-05 15:26:31 +0000146</div>
147<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000148 <a title="Sponsor: Diamonds are a Girls Best Friend" href="http://www.schmuck.org">Diamonds are a Girls Best Friend</a><!-- 201101010600 Peterssen-->
cristy916e1922009-10-01 12:52:47 +0000149</div>
150<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000151 <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
cristyb4c03bb2009-09-27 13:55:46 +0000152</div>
cristy3ed852e2009-09-05 21:47:34 +0000153</div>
154</div>
cristyce69bb02010-07-27 19:49:46 +0000155</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000156
cristyce69bb02010-07-27 19:49:46 +0000157<div class="eastbar">
158 <script type="text/javascript">
159 <!--
160 google_ad_client = "pub-3129977114552745";
cristyce69bb02010-07-27 19:49:46 +0000161 google_ad_slot = "0574824969";
162 google_ad_width = 160;
163 google_ad_height = 600;
164 //-->
165 </script>
166 <script type="text/javascript"
167 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
168 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000169</div>
170
171<div class="main">
172
cristy3ed852e2009-09-05 21:47:34 +0000173<p class="navigation-index">[<a href="#BlobToImage">BlobToImage</a> &bull; <a href="#FileToImage">FileToImage</a> &bull; <a href="#GetBlobProperties">GetBlobProperties</a> &bull; <a href="#ImageToBlob">ImageToBlob</a> &bull; <a href="#ImageToFile">ImageToFile</a> &bull; <a href="#ImagesToBlob">ImagesToBlob</a> &bull; <a href="#InjectImageBlob">InjectImageBlob</a>]</p>
174
175<h2><a href="http://www.imagemagick.org/api/MagickCore/blob
176_8c.html" target="source" name="BlobToImage">BlobToImage</a></h2>
177<div class="doc-section">
178
179<p>BlobToImage() implements direct to memory image formats. It returns the blob as an image.</p></ol>
180
181<p>The format of the BlobToImage method is:</p>
182
183<pre class="code">
184 Image *BlobToImage(const ImageInfo *image_info,const void *blob,
185 const size_t length,ExceptionInfo *exception)
186</pre>
187
188<p>A description of each parameter follows:</p></ol>
189
190<h5>image_info</h5>
191<ol><p>the image info.</p></ol>
192
193<h5>blob</h5>
194<ol><p>the address of a character stream in one of the image formats understood by ImageMagick.</p></ol>
195
196<h5>length</h5>
197<ol><p>This size_t integer reflects the length in bytes of the blob.</p></ol>
198
199<h5>exception</h5>
200<ol><p>return any errors or warnings in this structure.</p></ol>
201
202 </div>
203<h2><a href="http://www.imagemagick.org/api/MagickCore/blob
204_8c.html" target="source" name="FileToImage">FileToImage</a></h2>
205<div class="doc-section">
206
207<p>FileToImage() write the contents of a file to an image.</p></ol>
208
209<p>The format of the FileToImage method is:</p>
210
211<pre class="code">
212 MagickBooleanType FileToImage(Image *,const char *filename)
213</pre>
214
215<p>A description of each parameter follows:</p></ol>
216
217<h5>image</h5>
218<ol><p>the image.</p></ol>
219
220<h5>filename</h5>
221<ol><p>the filename.</p></ol>
222
223 </div>
224<h2><a href="http://www.imagemagick.org/api/MagickCore/blob
225_8c.html" target="source" name="GetBlobProperties">GetBlobProperties</a></h2>
226<div class="doc-section">
227
228<p>GetBlobProperties() returns information about an image blob.</p></ol>
229
230<p>The format of the GetBlobProperties method is:</p>
231
232<pre class="code">
233 const struct stat *GetBlobProperties(const Image *image)
234</pre>
235
236<p>A description of each parameter follows:</p></ol>
237
238<h5>image</h5>
239<ol><p>the image.</p></ol>
240
241 </div>
242<h2><a href="http://www.imagemagick.org/api/MagickCore/blob
243_8c.html" target="source" name="ImageToBlob">ImageToBlob</a></h2>
244<div class="doc-section">
245
246<p>ImageToBlob() implements direct to memory image formats. It returns the image as a blob and its length. The magick member of the ImageInfo structure determines the format of the returned blob (GIF, JPEG, PNG, etc.)</p></ol>
247
248<p>The format of the ImageToBlob method is:</p>
249
250<pre class="code">
251 unsigned char *ImageToBlob(const ImageInfo *image_info,Image *image,
252 size_t *length,ExceptionInfo *exception)
253</pre>
254
255<p>A description of each parameter follows:</p></ol>
256
257<h5>image_info</h5>
258<ol><p>the image info.</p></ol>
259
260<h5>image</h5>
261<ol><p>the image.</p></ol>
262
263<h5>length</h5>
264<ol><p>This pointer to a size_t integer sets the initial length of the blob. On return, it reflects the actual length of the blob.</p></ol>
265
266<h5>exception</h5>
267<ol><p>return any errors or warnings in this structure.</p></ol>
268
269 </div>
270<h2><a href="http://www.imagemagick.org/api/MagickCore/blob
271_8c.html" target="source" name="ImageToFile">ImageToFile</a></h2>
272<div class="doc-section">
273
274<p>ImageToFile() writes an image to a file. It returns MagickFalse if an error occurs otherwise MagickTrue.</p></ol>
275
276<p>The format of the ImageToFile method is:</p>
277
278<pre class="code">
279 MagickBooleanType ImageToFile(Image *image,char *filename,
280 ExceptionInfo *exception)
281</pre>
282
283<p>A description of each parameter follows:</p></ol>
284
285<h5>image</h5>
286<ol><p>the image.</p></ol>
287
288<h5>filename</h5>
289<ol><p>Write the image to this file.</p></ol>
290
291<h5>exception</h5>
292<ol><p>return any errors or warnings in this structure.</p></ol>
293
294 </div>
295<h2><a href="http://www.imagemagick.org/api/MagickCore/blob
296_8c.html" target="source" name="ImagesToBlob">ImagesToBlob</a></h2>
297<div class="doc-section">
298
299<p>ImagesToBlob() implements direct to memory image formats. It returns the image sequence as a blob and its length. The magick member of the ImageInfo structure determines the format of the returned blob (GIF, JPEG, PNG, etc.)</p></ol>
300
301<p>Note, some image formats do not permit multiple images to the same image stream (e.g. JPEG). in this instance, just the first image of the sequence is returned as a blob.</p></ol>
302
303<p>The format of the ImagesToBlob method is:</p>
304
305<pre class="code">
306 unsigned char *ImagesToBlob(const ImageInfo *image_info,Image *images,
307 size_t *length,ExceptionInfo *exception)
308</pre>
309
310<p>A description of each parameter follows:</p></ol>
311
312<h5>image_info</h5>
313<ol><p>the image info.</p></ol>
314
315<h5>images</h5>
316<ol><p>the image list.</p></ol>
317
318<h5>length</h5>
319<ol><p>This pointer to a size_t integer sets the initial length of the blob. On return, it reflects the actual length of the blob.</p></ol>
320
321<h5>exception</h5>
322<ol><p>return any errors or warnings in this structure.</p></ol>
323
324 </div>
325<h2><a href="http://www.imagemagick.org/api/MagickCore/blob
326_8c.html" target="source" name="InjectImageBlob">InjectImageBlob</a></h2>
327<div class="doc-section">
328
329<p>InjectImageBlob() injects the image with a copy of itself in the specified format (e.g. inject JPEG into a PDF image).</p></ol>
330
331<p>The format of the InjectImageBlob method is:</p>
332
333<pre class="code">
334 MagickBooleanType InjectImageBlob(const ImageInfo *image_info,
335 Image *image,Image *inject_image,const char *format,
336 ExceptionInfo *exception)
337</pre>
338
339<p>A description of each parameter follows:</p></ol>
340
341<h5>image_info</h5>
342<ol><p>the image info..</p></ol>
343
344<h5>image</h5>
345<ol><p>the image.</p></ol>
346
347<h5>inject_image</h5>
348<ol><p>inject into the image stream.</p></ol>
349
350<h5>format</h5>
351<ol><p>the image format.</p></ol>
352
353<h5>exception</h5>
354<ol><p>return any errors or warnings in this structure.</p></ol>
355
356 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000357
358</div>
359
360<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000361 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000362 <span id="linkbar-center">
363 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000364 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000365 </span>
366 <span id="linkbar-east">&nbsp;</span>
367 </div>
368 <div class="footer">
369 <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>
370 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
371 </div>
372 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000373 <script type="text/javascript">
374 var _gaq = _gaq || [];
375 _gaq.push(['_setAccount', 'UA-17690367-1']);
376 _gaq.push(['_trackPageview']);
377
378 (function() {
379 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
380 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
381 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
382 })();
383 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000384</body>
385</html>