granicus.if.org Git - imagemagick/blob - www/api/blob.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" \r
   2   "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">\r
   3 <html version="-//W3C//DTD XHTML 1.1//EN"\r
   4       xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"\r
   5       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"\r
   6       xsi:schemaLocation="http://www.w3.org/1999/xhtml\r
   7                           http://www.w3.org/MarkUp/SCHEMA/xhtml11.xsd">\r
   8 <head>\r
   9   <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>\r
  10   <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>\r
  11   <title>ImageMagick: MagickCore, C API for ImageMagick: Read or Write Binary Large OBjects</title>
  12   <meta http-equiv="Content-Language" content="en-US"/>
  13   <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
  14   <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
  15   <meta name="Application-name" content="ImageMagick"/>
  16   <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 automagically."/>
  17   <meta name="Application-url" content="http://www.imagemagick.org"/>
  18   <meta name="Generator" content="PHP"/>
  19   <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, Image, Processing, Automagically"/>
  20   <meta name="Rating" content="GENERAL"/>
  21   <meta name="Robots" content="INDEX, FOLLOW"/>
  22   <meta name="Generator" content="ImageMagick Studio LLC"/>
  23   <meta name="Author" content="ImageMagick Studio LLC"/>
  24   <meta name="Revisit-after" content="2 DAYS"/>
  25   <meta name="Resource-type" content="document"/>
  26   <meta name="Copyright" content="Copyright (c) 1999-2011 ImageMagick Studio LLC"/>
  27   <meta name="Distribution" content="Global"/>
  28   <link rel="icon" href="../../images/wand.png"/>
  29   <link rel="shortcut icon" href="../../images/wand.ico"  type="images/x-icon"/>
  30   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>\r
  31   <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />\r
  32   <style type="text/css" media="all">\r
  33     @import url("../../www/magick.css");\r
  34   </style>\r
  35   <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script>\r
  36   <script type="text/javascript" src="../fancybox/jquery.fancybox-1.3.4.pack.js"></script>\r
  37   <link rel="stylesheet" type="text/css" href="../fancybox/jquery.fancybox-1.3.4.css" media="screen" />\r
  38   <script type="text/javascript">\r
  39     $(document).ready(function() {\r
  40       $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({\r
  41         'transitionIn'  : 'elastic',\r
  42         'transitionOut' : 'elastic',\r
  43         'overlayShow'   : false,\r
  44         'opacity'       : true\r
  45       });\r
  46     });\r
  47   </script>\r
  48 </head>\r
  49 \r
  50 <body id="www-imagemagick-org">\r
  51 <div class="titlebar">\r
  52 <div style="margin: 17px auto; float: left;">\r
  53   <script type="text/javascript">\r
  54   <!--\r
  55     google_ad_client = "pub-3129977114552745";\r
  56     google_ad_slot = "5439289906";\r
  57     google_ad_width = 728;\r
  58     google_ad_height = 90;\r
  59   //-->\r
  60   </script>\r
  61   <script type="text/javascript"\r
  62     src="http://pagead2.googlesyndication.com/pagead/show_ads.js">\r
  63   </script>\r
  64 </div>\r
  65 <a href="http://www.imagemagick.org/discourse-server/">\r
  66   <img src="../../images/logo.jpg"\r
  67   alt="ImageMagick Logo"\r
  68   style="width: 123px; height: 118px; border: 0px; float: right;" /></a>\r
  69 <a href="../../index.html">\r
  70   <img src="../../images/sprite.jpg"\r
  71   alt="ImageMagick Sprite"\r
  72   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  73 </div>\r
  74 \r
  75 <div class="westbar">\r
  76 \r
  77 <div class="menu">
  78   <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
  79 </div>
  80 <div class="sep"></div>\r
  81 <div class="menu">
  82   <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
  83 </div>
  84 <div class="sub">
  85     <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
  86 </div>
  87 <div class="sub">
  88     <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
  89 </div>
  90 <div class="sub">
  91     <a title="Binary Release: iOS" href="../../www/binary-releases.html#iOS">iOS</a>
  92 </div>
  93 <div class="sub">
  94     <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
  95 </div>
  96 <div class="sep"></div>\r
  97 <div class="menu">
  98   <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
  99 </div>
 100 <div class="sub">
 101     <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
 102 </div>
 103 <div class="sub">
 104     <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
 105 </div>
 106 <div class="sub">
 107     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
 108 </div>
 109 <div class="menu">
 110   <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
 111 </div>
 112 <div class="sub">
 113     <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
 114 </div>
 115 <div class="sub">
 116     <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
 117 </div>
 118 <div class="sub">
 119     <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
 120 </div>
 121 <div class="sub">
 122     <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
 123 </div>
 124 <div class="sep"></div>\r
 125 <div  class="menu">
 126    <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
 127 </div>
 128 <div class="sub">
 129     <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
 130 </div>
 131 <div class="sub">
 132     <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
 133  </div>
 134 <div class="menu">
 135   <a title="Resources" href="../../www/resources.html">Resources</a>
 136 </div>
 137 <div class="menu">
 138   <a title="Architecture" href="../../www/architecture.html">Architecture</a>
 139 </div>
 140 <div class="menu">
 141   <a title="Download" href="../../www/download.html">Download</a>
 142 </div>
 143 <div class="sep"></div>\r
 144 <div class="menu">
 145   <a title="Search" href="../../www/search.html">Search</a>
 146 </div>
 147 <div class="sep"></div>\r
 148 <div class="menu">
 149   <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
 150 </div>
 151 <div  class="sub">
 152   <a title="Site Map: Links" href="../../www/links.html">Links</a>
 153 </div>
 154 <div class="sep"></div>\r
 155 <div  class="menu">
 156   <a rel="follow" title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
 157
 158 <a href="http://www.networkredux.com">
 159   <img src="../../images/networkredux.png" alt="[sponsor]"
 160   style="margin-top: 4px; margin-left: 4px; border: 0px; float: left;" /></a>
 161 <div class="sponsbox">
 162 <div  class="sponsor">
 163   <a rel="follow" title="Sponsor: Web Hosting" href="http://www.micfo.com">Web Hosting</a><!-- 209901010090s golestan -->
 164 </div>
 165 <div  class="sponsor">
 166   <a rel="follow" title="Sponsor: Search engine optimisation" href="http://www.seomoves.com.au">Search engine optimisation</a><!-- 201110010090s jen@seo lowprofilelinks -->
 167 </div>
 168 <div  class="sponsor">
 169   <a rel="follow" title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
 170 </div>
 171 <div  class="sponsor">
 172   <a rel="follow" title="Sponsor: Web Hosting Deals" href="http://www.webhostingdeals.org">Web Hosting Deals</a><!-- 201111010270 chee.hoa darin -->
 173 </div>
 174 <div  class="sponsor">
 175   <a rel="follow" title="Sponsor: Web Hosting Reviews" href="http://www.webhostingsecretrevealed.com">Web Hosting Secret Revealed</a><!-- 201204010540 iamchee jerry -->
 176 </div>
 177 <div  class="sponsor">
 178   <a rel="follow" title="Sponsor: Web Hosting Break" href="http://www.webhostingbreak.com">Web Hosting Break</a><!-- 201109010090 ian@ian-m... -->
 179 </div>
 180 <div  class="sponsor">
 181   <a rel="follow" title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201303011500 r.leo -->
 182 </div>
 183 <div  class="sponsor">
 184   <a rel="follow" title="Sponsor: Website Hosting" href="http://www.hostreviewgeeks.com">Website Hosting</a><!-- 201110010090 alexanian media -->
 185 </div>
 186 <div  class="sponsor">
 187   <a rel="follow" title="Sponsor: Hotel München" href="http://www.messehotel-erb-muenchen.de">Hotel München</a><!-- 201111010450 cerb -->
 188 </div>
 189 <div  class="sponsor">
 190   <a rel="follow" title="Sponsor: Best Web Hosting" href="http://webhostinggeeks.com">Best Web Hosting</a><!-- 201110010720 -->
 191 </div>
 192 <div  class="sponsor">
 193   <a rel="follow" title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
 194 </div>
 195 <div  class="sponsor">
 196   <a rel="follow" title="Sponsor: Web Hosting Reviews" href="http://www.webhostingmasters.com">Web Hosting Reviews</a><!-- 201107011500 affliatelabel -->
 197 </div>
 198 <div  class="sponsor">
 199   <a rel="follow" title="Sponsor: Web Hosting Ratings" href="http://webhostingrating.com">Web Hosting Ratings</a><!-- 201110010720 -->
 200 </div>
 201 <div  class="sponsor">
 202    <a rel="follow" title="Sponsor: Kaffeemaschinen reparatur" href="http://www.kaffeemaschinen-reparatur.de">Kaffeemaschinen reparatur</a><!-- 2011090100060 Temurbas atlas.multimedia-->
 203 </div>
 204 </div>
 205 </div>
 206 </div>\r
 207 \r
 208 <div class="eastbar">\r
 209 \r
 210 </div>\r
 211 \r
 212 <div class="main">\r
 213 \r
 214 <h1>Module blob Methods</h1>
 215 <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>
 216
 217 <h2><a href="http://www.imagemagick.org/api/MagickCore/blob_8c.html" id="BlobToImage">BlobToImage</a></h2>
 218 <div class="doc-section">
 219
 220 <p>BlobToImage() implements direct to memory image formats.  It returns the blob as an image.</p>
 221
 222 <p>The format of the BlobToImage method is:</p>
 223
 224 <pre class="code">
 225   Image *BlobToImage(const ImageInfo *image_info,const void *blob,
 226     const size_t length,ExceptionInfo *exception)
 227 </pre>
 228
 229 <p>A description of each parameter follows:</p>
 230
 231 <h5>image_info</h5>
 232 <p>the image info.</p>
 233
 234 <h5>blob</h5>
 235 <p>the address of a character stream in one of the image formats understood by ImageMagick.</p>
 236
 237 <h5>length</h5>
 238 <p>This size_t integer reflects the length in bytes of the blob.</p>
 239
 240 <h5>exception</h5>
 241 <p>return any errors or warnings in this structure.</p>
 242
 243  </div>
 244 <h2><a href="http://www.imagemagick.org/api/MagickCore/blob_8c.html" id="FileToImage">FileToImage</a></h2>
 245 <div class="doc-section">
 246
 247 <p>FileToImage() write the contents of a file to an image.</p>
 248
 249 <p>The format of the FileToImage method is:</p>
 250
 251 <pre class="code">
 252   MagickBooleanType FileToImage(Image *,const char *filename)
 253 </pre>
 254
 255 <p>A description of each parameter follows:</p>
 256
 257 <h5>image</h5>
 258 <p>the image.</p>
 259
 260 <h5>filename</h5>
 261 <p>the filename.</p>
 262
 263  </div>
 264 <h2><a href="http://www.imagemagick.org/api/MagickCore/blob_8c.html" id="GetBlobProperties">GetBlobProperties</a></h2>
 265 <div class="doc-section">
 266
 267 <p>GetBlobProperties() returns information about an image blob.</p>
 268
 269 <p>The format of the GetBlobProperties method is:</p>
 270
 271 <pre class="code">
 272   const struct stat *GetBlobProperties(const Image *image)
 273 </pre>
 274
 275 <p>A description of each parameter follows:</p>
 276
 277 <h5>image</h5>
 278 <p>the image.</p>
 279
 280  </div>
 281 <h2><a href="http://www.imagemagick.org/api/MagickCore/blob_8c.html" id="ImageToBlob">ImageToBlob</a></h2>
 282 <div class="doc-section">
 283
 284 <p>ImageToBlob() implements direct to memory image formats.  It returns the image as a formatted 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>
 285
 286 <p>The format of the ImageToBlob method is:</p>
 287
 288 <pre class="code">
 289   unsigned char *ImageToBlob(const ImageInfo *image_info,Image *image,
 290     size_t *length,ExceptionInfo *exception)
 291 </pre>
 292
 293 <p>A description of each parameter follows:</p>
 294
 295 <h5>image_info</h5>
 296 <p>the image info.</p>
 297
 298 <h5>image</h5>
 299 <p>the image.</p>
 300
 301 <h5>length</h5>
 302 <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>
 303
 304 <h5>exception</h5>
 305 <p>return any errors or warnings in this structure.</p>
 306
 307  </div>
 308 <h2><a href="http://www.imagemagick.org/api/MagickCore/blob_8c.html" id="ImageToFile">ImageToFile</a></h2>
 309 <div class="doc-section">
 310
 311 <p>ImageToFile() writes an image to a file.  It returns MagickFalse if an error occurs otherwise MagickTrue.</p>
 312
 313 <p>The format of the ImageToFile method is:</p>
 314
 315 <pre class="code">
 316    MagickBooleanType ImageToFile(Image *image,char *filename,
 317      ExceptionInfo *exception)
 318 </pre>
 319
 320 <p>A description of each parameter follows:</p>
 321
 322 <h5>image</h5>
 323 <p>the image.</p>
 324
 325 <h5>filename</h5>
 326 <p>Write the image to this file.</p>
 327
 328 <h5>exception</h5>
 329 <p>return any errors or warnings in this structure.</p>
 330
 331  </div>
 332 <h2><a href="http://www.imagemagick.org/api/MagickCore/blob_8c.html" id="ImagesToBlob">ImagesToBlob</a></h2>
 333 <div class="doc-section">
 334
 335 <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>
 336
 337 <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>
 338
 339 <p>The format of the ImagesToBlob method is:</p>
 340
 341 <pre class="code">
 342   unsigned char *ImagesToBlob(const ImageInfo *image_info,Image *images,
 343     size_t *length,ExceptionInfo *exception)
 344 </pre>
 345
 346 <p>A description of each parameter follows:</p>
 347
 348 <h5>image_info</h5>
 349 <p>the image info.</p>
 350
 351 <h5>images</h5>
 352 <p>the image list.</p>
 353
 354 <h5>length</h5>
 355 <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>
 356
 357 <h5>exception</h5>
 358 <p>return any errors or warnings in this structure.</p>
 359
 360  </div>
 361 <h2><a href="http://www.imagemagick.org/api/MagickCore/blob_8c.html" id="InjectImageBlob">InjectImageBlob</a></h2>
 362 <div class="doc-section">
 363
 364 <p>InjectImageBlob() injects the image with a copy of itself in the specified format (e.g. inject JPEG into a PDF image).</p>
 365
 366 <p>The format of the InjectImageBlob method is:</p>
 367
 368 <pre class="code">
 369   MagickBooleanType InjectImageBlob(const ImageInfo *image_info,
 370     Image *image,Image *inject_image,const char *format,
 371     ExceptionInfo *exception)
 372 </pre>
 373
 374 <p>A description of each parameter follows:</p>
 375
 376 <h5>image_info</h5>
 377 <p>the image info..</p>
 378
 379 <h5>image</h5>
 380 <p>the image.</p>
 381
 382 <h5>inject_image</h5>
 383 <p>inject into the image stream.</p>
 384
 385 <h5>format</h5>
 386 <p>the image format.</p>
 387
 388 <h5>exception</h5>
 389 <p>return any errors or warnings in this structure.</p>
 390
 391  </div>
 392 \r
 393 </div>\r
 394 \r
 395 <div id="linkbar">\r
 396     <span id="linkbar-west">&nbsp;</span>\r
 397     <span id="linkbar-center">\r
 398       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 399       <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 400     </span>\r
 401     <span id="linkbar-east">&nbsp;</span>\r
 402   </div>\r
 403   <div class="footer">\r
 404     <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>\r
 405     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 406   </div>\r
 407   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 408   <script type="text/javascript">\r
 409     var _gaq = _gaq || [];\r
 410     _gaq.push(['_setAccount', 'UA-17690367-1']);\r
 411     _gaq.push(['_trackPageview']);\r
 412 \r
 413     (function() {\r
 414       var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;\r
 415       ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';\r
 416       var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);\r
 417     })();\r
 418   </script>\r
 419 </body>\r
 420 </html>\r