Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / af8d6655e12345c48d687558c0665070d206a942 / . / www / api / blob.html
blob: 77575f2badac8394d4aa13459daf0b099ed45ca2 [file] [log] [blame]
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" dir="ltr">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]4<head>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
6 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]7 <title>ImageMagick: MagickCore, C API for ImageMagick: Read or Write Binary Large OBjects</title>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]8 <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 +0000[diff] [blame]11 <meta name="Application-name" content="ImageMagick"/>
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame^]12 <meta name="Description" content="Use ImageMagick to convert, edit, or compose bitmap images in a variety of formats. In addition resize, rotate, shear, distort and transform images."/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]13 <meta name="Application-url" content="http://www.imagemagick.org"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]14 <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 +0000[diff] [blame]16 <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"/>
cristy4103d562010-12-10 01:38:54 +0000[diff] [blame]22 <meta name="Copyright" content="Copyright (c) 1999-2011 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]23 <meta name="Distribution" content="Global"/>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]24 <link rel="icon" href="../../images/wand.png"/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]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"/>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]27 <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]28 <style type="text/css" media="all">
29 @import url("../../www/magick.css");
30 </style>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]31 <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script>
cristy361f4662010-12-31 23:02:52 +0000[diff] [blame]32 <script type="text/javascript" src="../fancybox/jquery.fancybox-1.3.4.pack.js"></script>
33 <link rel="stylesheet" type="text/css" href="../fancybox/jquery.fancybox-1.3.4.css" media="screen" />
34 <script type="text/javascript">
35 $(document).ready(function() {
36 $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({
37 'transitionIn' : 'elastic',
38 'transitionOut' : 'elastic',
39 'overlayShow' : false,
40 'opacity' : true
41 });
42 });
43 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]44</head>
45
46<body id="www-imagemagick-org">
47<div class="titlebar">
48<a href="../../index.html">
49 <img src="../../images/script.png" alt="[ImageMagick]"
50 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
51<a href="http://www.networkredux.com">
52 <img src="../../images/networkredux.png" alt="[sponsor]"
cristy52923442011-01-15 22:54:31 +0000[diff] [blame]53 style="margin-top: 42px; border: 0px; float: left;" /></a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]54<a href="http://www.imagemagick.org/discourse-server/">
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame^]55 <img src="../../images/logo.jpg"
56 alt="ImageMagick Logo"
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]57 style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]58<a href="../../index.html">
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame^]59 <img src="../../images/sprite.jpg"
60 alt="ImageMagick Sprite"
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]61 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
62</div>
63
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]64<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]65
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]66<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]67 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]68</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]69<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]70<div class="menu">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]71 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
72</div>
73<div class="sub">
74 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
75</div>
76<div class="sub">
77 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
78</div>
79<div class="sub">
80 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
81</div>
82<div class="sep"></div>
83<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]84 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]85</div>
86<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]87 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]88</div>
89<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]90 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]91</div>
92<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]93 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]94</div>
95<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]96 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]97</div>
98<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]99 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]100</div>
101<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]102 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]103</div>
104<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]105 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]106</div>
107<div class="sub">
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]108 <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]109</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]110<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]111<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]112 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]113</div>
114<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]115 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]116</div>
117<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]118 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]119 </div>
120<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]121 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]122</div>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]123<div class="menu">
124 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
125</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]126<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]127 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]128</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]129<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]130<div class="menu">
cristy52923442011-01-15 22:54:31 +0000[diff] [blame]131 <a title="Search" href="../../www/search.html">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]132</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]133<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]134<div class="menu">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]135 <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]136</div>
137<div class="sub">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]138 <a title="Site Map: Links" href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]139</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]140<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]141<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]142 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]143
144<div class="sponsbox">
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]145<div class="sponsor">
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame^]146 <a title="Sponsor: Best Web Hosting" href="http://webhostinggeeks.com">Best Web Hosting</a><!-- 201110010720 -->
147</div>
148<div class="sponsor">
149 <a title="Sponsor: Web Hosting Ratings" href="http://webhostingrating.com">Web Hosting Ratings</a><!-- 201110010720 -->
150</div>
151<div class="sponsor">
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]152 <a title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201106010240 -->
153</div>
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]154<div class="sponsor">
cristy52923442011-01-15 22:54:31 +0000[diff] [blame]155 <a title="Sponsor: Web Hosting" href="http://www.bodhost.com/hosting.shtml">Web Hosting</a><!-- 201104010090 -->
cristy7d52cd62010-10-01 17:26:59 +0000[diff] [blame]156</div>
157<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000[diff] [blame]158 <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
159</div>
160<div class="sponsor">
cristy851dbce2010-08-06 21:40:00 +0000[diff] [blame]161 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
162</div>
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]163<div class="sponsor">
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]164 <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
165</div>
166<div class="sponsor">
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame^]167 <a title="Sponsor: Free Catalogs" href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 20120801000600 -->
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]168</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]169</div>
170</div>
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]171</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]172
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]173<div class="eastbar">
174 <script type="text/javascript">
175 <!--
176 google_ad_client = "pub-3129977114552745";
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]177 google_ad_slot = "0574824969";
178 google_ad_width = 160;
179 google_ad_height = 600;
180 //-->
181 </script>
182 <script type="text/javascript"
183 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
184 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]185</div>
186
187<div class="main">
188
cristy307ba182010-12-25 01:00:34 +0000[diff] [blame]189<h1>Module blob
190 Methods</h1>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]191<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>
192
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]193<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/blob
194_8c.html" id="BlobToImage">BlobToImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]195<div class="doc-section">
196
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]197<p>BlobToImage() implements direct to memory image formats. It returns the blob as an image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]198
199<p>The format of the BlobToImage method is:</p>
200
201<pre class="code">
202 Image *BlobToImage(const ImageInfo *image_info,const void *blob,
203 const size_t length,ExceptionInfo *exception)
204</pre>
205
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]206<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]207
208<h5>image_info</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]209<p>the image info.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]210
211<h5>blob</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]212<p>the address of a character stream in one of the image formats understood by ImageMagick.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]213
214<h5>length</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]215<p>This size_t integer reflects the length in bytes of the blob.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]216
217<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]218<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]219
220 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]221<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/blob
222_8c.html" id="FileToImage">FileToImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]223<div class="doc-section">
224
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]225<p>FileToImage() write the contents of a file to an image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]226
227<p>The format of the FileToImage method is:</p>
228
229<pre class="code">
230 MagickBooleanType FileToImage(Image *,const char *filename)
231</pre>
232
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]233<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]234
235<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]236<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]237
238<h5>filename</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]239<p>the filename.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]240
241 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]242<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/blob
243_8c.html" id="GetBlobProperties">GetBlobProperties</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]244<div class="doc-section">
245
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]246<p>GetBlobProperties() returns information about an image blob.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]247
248<p>The format of the GetBlobProperties method is:</p>
249
250<pre class="code">
251 const struct stat *GetBlobProperties(const Image *image)
252</pre>
253
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]254<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]255
256<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]257<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]258
259 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]260<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/blob
261_8c.html" id="ImageToBlob">ImageToBlob</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]262<div class="doc-section">
263
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame^]264<p>ImageToBlob() implements direct to memory image formats. It returns the image as a blob and its length. The magick member of the Image structure determines the format of the returned blob (GIF, JPEG, PNG, etc.). This method is the equivalent of WriteImage(), but writes the formatted "file" to a memory buffer rather than to an actual file.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]265
266<p>The format of the ImageToBlob method is:</p>
267
268<pre class="code">
269 unsigned char *ImageToBlob(const ImageInfo *image_info,Image *image,
270 size_t *length,ExceptionInfo *exception)
271</pre>
272
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]273<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]274
275<h5>image_info</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]276<p>the image info.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]277
278<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]279<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]280
281<h5>length</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]282<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]283
284<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]285<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]286
287 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]288<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/blob
289_8c.html" id="ImageToFile">ImageToFile</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]290<div class="doc-section">
291
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]292<p>ImageToFile() writes an image to a file. It returns MagickFalse if an error occurs otherwise MagickTrue.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]293
294<p>The format of the ImageToFile method is:</p>
295
296<pre class="code">
297 MagickBooleanType ImageToFile(Image *image,char *filename,
298 ExceptionInfo *exception)
299</pre>
300
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]301<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]302
303<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]304<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]305
306<h5>filename</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]307<p>Write the image to this file.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]308
309<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]310<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]311
312 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]313<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/blob
314_8c.html" id="ImagesToBlob">ImagesToBlob</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]315<div class="doc-section">
316
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]317<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]318
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]319<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]320
321<p>The format of the ImagesToBlob method is:</p>
322
323<pre class="code">
324 unsigned char *ImagesToBlob(const ImageInfo *image_info,Image *images,
325 size_t *length,ExceptionInfo *exception)
326</pre>
327
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]328<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]329
330<h5>image_info</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]331<p>the image info.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]332
333<h5>images</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]334<p>the image list.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]335
336<h5>length</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]337<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]338
339<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]340<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]341
342 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]343<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/blob
344_8c.html" id="InjectImageBlob">InjectImageBlob</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]345<div class="doc-section">
346
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]347<p>InjectImageBlob() injects the image with a copy of itself in the specified format (e.g. inject JPEG into a PDF image).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]348
349<p>The format of the InjectImageBlob method is:</p>
350
351<pre class="code">
352 MagickBooleanType InjectImageBlob(const ImageInfo *image_info,
353 Image *image,Image *inject_image,const char *format,
354 ExceptionInfo *exception)
355</pre>
356
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]357<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]358
359<h5>image_info</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]360<p>the image info..</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]361
362<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]363<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]364
365<h5>inject_image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]366<p>inject into the image stream.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]367
368<h5>format</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]369<p>the image format.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]370
371<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]372<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]373
374 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]375
376</div>
377
378<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]379 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]380 <span id="linkbar-center">
381 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]382 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]383 </span>
384 <span id="linkbar-east">&nbsp;</span>
385 </div>
386 <div class="footer">
cristy4103d562010-12-10 01:38:54 +0000[diff] [blame]387 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]388 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
389 </div>
390 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]391 <script type="text/javascript">
392 var _gaq = _gaq || [];
393 _gaq.push(['_setAccount', 'UA-17690367-1']);
394 _gaq.push(['_trackPageview']);
395
396 (function() {
397 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
398 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
399 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
400 })();
401 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]402</body>
403</html>