blob: 14915df68e662fca3804916bded784503fff9394 [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>
cristy3de29cc2010-04-15 02:34:44 +00005 <meta http-equiv="content-type" content="text/html; charset=utf-8"/>
cristy3eaa0ef2010-03-06 20:35:26 +00006 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />
7 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />
cristy3de29cc2010-04-15 02:34:44 +00008 <style type="text/css" media="all">
cristy3eaa0ef2010-03-06 20:35:26 +00009 @import url("../../www/magick.css");
cristy3de29cc2010-04-15 02:34:44 +000010 </style>
cristy3ed852e2009-09-05 21:47:34 +000011 <link rel="shortcut icon" href="../../images/wand.ico" type="images/vnd.microsoft.icon"/>
12 <title>ImageMagick: MagickCore, C API for ImageMagick: Read or Write Binary Large OBjects</title>
13 <meta http-equiv="Content-Language" content="en-US"/>
14 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
15 <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
16 <meta name="Generator" content="PHP"/>
17 <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"/>
18 <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."/>
19 <meta name="Rating" content="GENERAL"/>
20 <meta name="Robots" content="INDEX, FOLLOW"/>
21 <meta name="Generator" content="ImageMagick Studio LLC"/>
22 <meta name="Author" content="ImageMagick Studio LLC"/>
23 <meta name="Revisit-after" content="2 DAYS"/>
24 <meta name="Resource-type" content="document"/>
cristy16af1cb2009-12-11 21:38:29 +000025 <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +000026 <meta name="Distribution" content="Global"/>
cristy3eaa0ef2010-03-06 20:35:26 +000027</head>
28
29<body id="www-imagemagick-org">
30<div class="titlebar">
31<a href="../../index.html">
32 <img src="../../images/script.png" alt="[ImageMagick]"
33 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
34<a href="http://www.networkredux.com">
35 <img src="../../images/networkredux.png" alt="[sponsor]"
36 style="margin: 45px auto; border: 0px; float: left;" /></a>
37<a href="http://www.imagemagick.org/discourse-server/">
38 <img src="../../images/logo.jpg" alt=""
39 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
40<a href="../../index.html">
41 <img src="../../images/sprite.jpg" alt=""
42 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
43</div>
44
cristyce69bb02010-07-27 19:49:46 +000045<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +000046
cristy3ed852e2009-09-05 21:47:34 +000047<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000048 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +000049</div>
cristy3eaa0ef2010-03-06 20:35:26 +000050<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +000051<div class="menu">
cristybb503372010-05-27 20:51:26 +000052 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
53</div>
54<div class="sub">
55 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
56</div>
57<div class="sub">
58 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
59</div>
60<div class="sub">
61 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
62</div>
63<div class="sep"></div>
64<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000065 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +000066</div>
67<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000068 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</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: Options" href="../../www/command-line-options.html">Options</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: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +000075</div>
76<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000077 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +000078</div>
79<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000080 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +000081</div>
82<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000083 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +000084</div>
85<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000086 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +000087</div>
88<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000089 <a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +000090</div>
cristy3eaa0ef2010-03-06 20:35:26 +000091<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +000092<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000093 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +000094</div>
95<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000096 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</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: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000100 </div>
101<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000102 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000103</div>
cristybb503372010-05-27 20:51:26 +0000104<div class="menu">
105 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
106</div>
cristy3ed852e2009-09-05 21:47:34 +0000107<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000108 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000109</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000110<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000111<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000112 <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000113</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000114<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000115<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000116 <a title="Site Map"href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000117</div>
118<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000119 <a title="Site Map: Links"href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000120</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000121<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000122<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000123 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000124
125<div class="sponsbox">
126<div class="sponsor">
cristy851dbce2010-08-06 21:40:00 +0000127 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
128</div>
129<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000130 <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
cristyc02484c2010-03-08 00:14:58 +0000131</div>
132<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000133 <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
cristy8f900122010-03-05 15:26:31 +0000134</div>
135<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000136 <a title="Sponsor: Deko.net" href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
cristy1f9e1ed2009-11-18 04:09:38 +0000137</div>
138<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000139 <a title="Sponsor: Druckerei" href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
cristy916e1922009-10-01 12:52:47 +0000140</div>
141<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000142 <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
cristyb4c03bb2009-09-27 13:55:46 +0000143</div>
cristyf1310b52010-05-15 16:42:04 +0000144<div class="sponsor">
cristy851dbce2010-08-06 21:40:00 +0000145 <a title="Sponsor: Free Catalogs" href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 20120801000600 -->
cristyf1310b52010-05-15 16:42:04 +0000146</div>
cristy3ed852e2009-09-05 21:47:34 +0000147</div>
148</div>
cristyce69bb02010-07-27 19:49:46 +0000149</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000150
cristyce69bb02010-07-27 19:49:46 +0000151<div class="eastbar">
152 <script type="text/javascript">
153 <!--
154 google_ad_client = "pub-3129977114552745";
cristyce69bb02010-07-27 19:49:46 +0000155 google_ad_slot = "0574824969";
156 google_ad_width = 160;
157 google_ad_height = 600;
158 //-->
159 </script>
160 <script type="text/javascript"
161 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
162 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000163</div>
164
165<div class="main">
166
cristy3ed852e2009-09-05 21:47:34 +0000167<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>
168
169<h2><a href="http://www.imagemagick.org/api/MagickCore/blob
170_8c.html" target="source" name="BlobToImage">BlobToImage</a></h2>
171<div class="doc-section">
172
173<p>BlobToImage() implements direct to memory image formats. It returns the blob as an image.</p></ol>
174
175<p>The format of the BlobToImage method is:</p>
176
177<pre class="code">
178 Image *BlobToImage(const ImageInfo *image_info,const void *blob,
179 const size_t length,ExceptionInfo *exception)
180</pre>
181
182<p>A description of each parameter follows:</p></ol>
183
184<h5>image_info</h5>
185<ol><p>the image info.</p></ol>
186
187<h5>blob</h5>
188<ol><p>the address of a character stream in one of the image formats understood by ImageMagick.</p></ol>
189
190<h5>length</h5>
191<ol><p>This size_t integer reflects the length in bytes of the blob.</p></ol>
192
193<h5>exception</h5>
194<ol><p>return any errors or warnings in this structure.</p></ol>
195
196 </div>
197<h2><a href="http://www.imagemagick.org/api/MagickCore/blob
198_8c.html" target="source" name="FileToImage">FileToImage</a></h2>
199<div class="doc-section">
200
201<p>FileToImage() write the contents of a file to an image.</p></ol>
202
203<p>The format of the FileToImage method is:</p>
204
205<pre class="code">
206 MagickBooleanType FileToImage(Image *,const char *filename)
207</pre>
208
209<p>A description of each parameter follows:</p></ol>
210
211<h5>image</h5>
212<ol><p>the image.</p></ol>
213
214<h5>filename</h5>
215<ol><p>the filename.</p></ol>
216
217 </div>
218<h2><a href="http://www.imagemagick.org/api/MagickCore/blob
219_8c.html" target="source" name="GetBlobProperties">GetBlobProperties</a></h2>
220<div class="doc-section">
221
222<p>GetBlobProperties() returns information about an image blob.</p></ol>
223
224<p>The format of the GetBlobProperties method is:</p>
225
226<pre class="code">
227 const struct stat *GetBlobProperties(const Image *image)
228</pre>
229
230<p>A description of each parameter follows:</p></ol>
231
232<h5>image</h5>
233<ol><p>the image.</p></ol>
234
235 </div>
236<h2><a href="http://www.imagemagick.org/api/MagickCore/blob
237_8c.html" target="source" name="ImageToBlob">ImageToBlob</a></h2>
238<div class="doc-section">
239
240<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>
241
242<p>The format of the ImageToBlob method is:</p>
243
244<pre class="code">
245 unsigned char *ImageToBlob(const ImageInfo *image_info,Image *image,
246 size_t *length,ExceptionInfo *exception)
247</pre>
248
249<p>A description of each parameter follows:</p></ol>
250
251<h5>image_info</h5>
252<ol><p>the image info.</p></ol>
253
254<h5>image</h5>
255<ol><p>the image.</p></ol>
256
257<h5>length</h5>
258<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>
259
260<h5>exception</h5>
261<ol><p>return any errors or warnings in this structure.</p></ol>
262
263 </div>
264<h2><a href="http://www.imagemagick.org/api/MagickCore/blob
265_8c.html" target="source" name="ImageToFile">ImageToFile</a></h2>
266<div class="doc-section">
267
268<p>ImageToFile() writes an image to a file. It returns MagickFalse if an error occurs otherwise MagickTrue.</p></ol>
269
270<p>The format of the ImageToFile method is:</p>
271
272<pre class="code">
273 MagickBooleanType ImageToFile(Image *image,char *filename,
274 ExceptionInfo *exception)
275</pre>
276
277<p>A description of each parameter follows:</p></ol>
278
279<h5>image</h5>
280<ol><p>the image.</p></ol>
281
282<h5>filename</h5>
283<ol><p>Write the image to this file.</p></ol>
284
285<h5>exception</h5>
286<ol><p>return any errors or warnings in this structure.</p></ol>
287
288 </div>
289<h2><a href="http://www.imagemagick.org/api/MagickCore/blob
290_8c.html" target="source" name="ImagesToBlob">ImagesToBlob</a></h2>
291<div class="doc-section">
292
293<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>
294
295<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>
296
297<p>The format of the ImagesToBlob method is:</p>
298
299<pre class="code">
300 unsigned char *ImagesToBlob(const ImageInfo *image_info,Image *images,
301 size_t *length,ExceptionInfo *exception)
302</pre>
303
304<p>A description of each parameter follows:</p></ol>
305
306<h5>image_info</h5>
307<ol><p>the image info.</p></ol>
308
309<h5>images</h5>
310<ol><p>the image list.</p></ol>
311
312<h5>length</h5>
313<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>
314
315<h5>exception</h5>
316<ol><p>return any errors or warnings in this structure.</p></ol>
317
318 </div>
319<h2><a href="http://www.imagemagick.org/api/MagickCore/blob
320_8c.html" target="source" name="InjectImageBlob">InjectImageBlob</a></h2>
321<div class="doc-section">
322
323<p>InjectImageBlob() injects the image with a copy of itself in the specified format (e.g. inject JPEG into a PDF image).</p></ol>
324
325<p>The format of the InjectImageBlob method is:</p>
326
327<pre class="code">
328 MagickBooleanType InjectImageBlob(const ImageInfo *image_info,
329 Image *image,Image *inject_image,const char *format,
330 ExceptionInfo *exception)
331</pre>
332
333<p>A description of each parameter follows:</p></ol>
334
335<h5>image_info</h5>
336<ol><p>the image info..</p></ol>
337
338<h5>image</h5>
339<ol><p>the image.</p></ol>
340
341<h5>inject_image</h5>
342<ol><p>inject into the image stream.</p></ol>
343
344<h5>format</h5>
345<ol><p>the image format.</p></ol>
346
347<h5>exception</h5>
348<ol><p>return any errors or warnings in this structure.</p></ol>
349
350 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000351
352</div>
353
354<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000355 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000356 <span id="linkbar-center">
357 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000358 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000359 </span>
360 <span id="linkbar-east">&nbsp;</span>
361 </div>
362 <div class="footer">
363 <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>
364 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
365 </div>
366 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000367 <script type="text/javascript">
368 var _gaq = _gaq || [];
369 _gaq.push(['_setAccount', 'UA-17690367-1']);
370 _gaq.push(['_trackPageview']);
371
372 (function() {
373 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
374 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
375 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
376 })();
377 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000378</body>
379</html>