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: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
 167 </div>
 168 <div  class="sponsor">
 169   <a rel="follow" title="Sponsor: Web Hosting Deals" href="http://www.webhostingdeals.org">Web Hosting Deals</a><!-- 201111010270 chee.hoa darin -->
 170 </div>
 171 <div  class="sponsor">
 172   <a rel="follow" title="Sponsor: Web Hosting Reviews" href="http://www.webhostingsecretrevealed.com">Web Hosting Secret Revealed</a><!-- 201204010540 iamchee jerry -->
 173 </div>
 174 <div  class="sponsor">
 175   <a rel="follow" title="Sponsor: Web Hosting Break" href="http://www.webhostingbreak.com">Web Hosting Break</a><!-- 201109010090 ian@ian-m... -->
 176 </div>
 177 <div  class="sponsor">
 178   <a rel="follow" title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201303011500 r.leo -->
 179 </div>
 180 <div  class="sponsor">
 181   <a rel="follow" title="Sponsor: Website Hosting" href="http://www.hostreviewgeeks.com">Website Hosting</a><!-- 201110010090 alexanian media -->
 182 </div>
 183 <div  class="sponsor">
 184   <a rel="follow" title="Sponsor: Hotel München" href="http://www.messehotel-erb-muenchen.de">Hotel München</a><!-- 201111010450 cerb -->
 185 </div>
 186 <div  class="sponsor">
 187   <a rel="follow" title="Sponsor: Best Web Hosting" href="http://webhostinggeeks.com">Best Web Hosting</a><!-- 201110010720 -->
 188 </div>
 189 <div  class="sponsor">
 190   <a rel="follow" title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
 191 </div>
 192 <div  class="sponsor">
 193   <a rel="follow" title="Sponsor: Web Hosting Reviews" href="http://www.webhostingmasters.com">Web Hosting Reviews</a><!-- 201107011500 affliatelabel -->
 194 </div>
 195 <div  class="sponsor">
 196   <a rel="follow" title="Sponsor: Web Hosting Ratings" href="http://webhostingrating.com">Web Hosting Ratings</a><!-- 201110010720 -->
 197 </div>
 198 <div  class="sponsor">
 199    <a rel="follow" title="Sponsor: Free Catalogs" href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 20120801000600 -->
 200 </div>
 201 </div>
 202 </div>
 203 </div>\r
 204 \r
 205 <div class="eastbar">\r
 206 \r
 207 </div>\r
 208 \r
 209 <div class="main">\r
 210 \r
 211 <h1>Module blob Methods</h1>
 212 <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>
 213
 214 <h2><a href="http://www.imagemagick.org/api/MagickCore/blob_8c.html" id="BlobToImage">BlobToImage</a></h2>
 215 <div class="doc-section">
 216
 217 <p>BlobToImage() implements direct to memory image formats.  It returns the blob as an image.</p>
 218
 219 <p>The format of the BlobToImage method is:</p>
 220
 221 <pre class="code">
 222   Image *BlobToImage(const ImageInfo *image_info,const void *blob,
 223     const size_t length,ExceptionInfo *exception)
 224 </pre>
 225
 226 <p>A description of each parameter follows:</p>
 227
 228 <h5>image_info</h5>
 229 <p>the image info.</p>
 230
 231 <h5>blob</h5>
 232 <p>the address of a character stream in one of the image formats understood by ImageMagick.</p>
 233
 234 <h5>length</h5>
 235 <p>This size_t integer reflects the length in bytes of the blob.</p>
 236
 237 <h5>exception</h5>
 238 <p>return any errors or warnings in this structure.</p>
 239
 240  </div>
 241 <h2><a href="http://www.imagemagick.org/api/MagickCore/blob_8c.html" id="FileToImage">FileToImage</a></h2>
 242 <div class="doc-section">
 243
 244 <p>FileToImage() write the contents of a file to an image.</p>
 245
 246 <p>The format of the FileToImage method is:</p>
 247
 248 <pre class="code">
 249   MagickBooleanType FileToImage(Image *,const char *filename)
 250 </pre>
 251
 252 <p>A description of each parameter follows:</p>
 253
 254 <h5>image</h5>
 255 <p>the image.</p>
 256
 257 <h5>filename</h5>
 258 <p>the filename.</p>
 259
 260  </div>
 261 <h2><a href="http://www.imagemagick.org/api/MagickCore/blob_8c.html" id="GetBlobProperties">GetBlobProperties</a></h2>
 262 <div class="doc-section">
 263
 264 <p>GetBlobProperties() returns information about an image blob.</p>
 265
 266 <p>The format of the GetBlobProperties method is:</p>
 267
 268 <pre class="code">
 269   const struct stat *GetBlobProperties(const Image *image)
 270 </pre>
 271
 272 <p>A description of each parameter follows:</p>
 273
 274 <h5>image</h5>
 275 <p>the image.</p>
 276
 277  </div>
 278 <h2><a href="http://www.imagemagick.org/api/MagickCore/blob_8c.html" id="ImageToBlob">ImageToBlob</a></h2>
 279 <div class="doc-section">
 280
 281 <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>
 282
 283 <p>The format of the ImageToBlob method is:</p>
 284
 285 <pre class="code">
 286   unsigned char *ImageToBlob(const ImageInfo *image_info,Image *image,
 287     size_t *length,ExceptionInfo *exception)
 288 </pre>
 289
 290 <p>A description of each parameter follows:</p>
 291
 292 <h5>image_info</h5>
 293 <p>the image info.</p>
 294
 295 <h5>image</h5>
 296 <p>the image.</p>
 297
 298 <h5>length</h5>
 299 <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>
 300
 301 <h5>exception</h5>
 302 <p>return any errors or warnings in this structure.</p>
 303
 304  </div>
 305 <h2><a href="http://www.imagemagick.org/api/MagickCore/blob_8c.html" id="ImageToFile">ImageToFile</a></h2>
 306 <div class="doc-section">
 307
 308 <p>ImageToFile() writes an image to a file.  It returns MagickFalse if an error occurs otherwise MagickTrue.</p>
 309
 310 <p>The format of the ImageToFile method is:</p>
 311
 312 <pre class="code">
 313    MagickBooleanType ImageToFile(Image *image,char *filename,
 314      ExceptionInfo *exception)
 315 </pre>
 316
 317 <p>A description of each parameter follows:</p>
 318
 319 <h5>image</h5>
 320 <p>the image.</p>
 321
 322 <h5>filename</h5>
 323 <p>Write the image to this file.</p>
 324
 325 <h5>exception</h5>
 326 <p>return any errors or warnings in this structure.</p>
 327
 328  </div>
 329 <h2><a href="http://www.imagemagick.org/api/MagickCore/blob_8c.html" id="ImagesToBlob">ImagesToBlob</a></h2>
 330 <div class="doc-section">
 331
 332 <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>
 333
 334 <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>
 335
 336 <p>The format of the ImagesToBlob method is:</p>
 337
 338 <pre class="code">
 339   unsigned char *ImagesToBlob(const ImageInfo *image_info,Image *images,
 340     size_t *length,ExceptionInfo *exception)
 341 </pre>
 342
 343 <p>A description of each parameter follows:</p>
 344
 345 <h5>image_info</h5>
 346 <p>the image info.</p>
 347
 348 <h5>images</h5>
 349 <p>the image list.</p>
 350
 351 <h5>length</h5>
 352 <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>
 353
 354 <h5>exception</h5>
 355 <p>return any errors or warnings in this structure.</p>
 356
 357  </div>
 358 <h2><a href="http://www.imagemagick.org/api/MagickCore/blob_8c.html" id="InjectImageBlob">InjectImageBlob</a></h2>
 359 <div class="doc-section">
 360
 361 <p>InjectImageBlob() injects the image with a copy of itself in the specified format (e.g. inject JPEG into a PDF image).</p>
 362
 363 <p>The format of the InjectImageBlob method is:</p>
 364
 365 <pre class="code">
 366   MagickBooleanType InjectImageBlob(const ImageInfo *image_info,
 367     Image *image,Image *inject_image,const char *format,
 368     ExceptionInfo *exception)
 369 </pre>
 370
 371 <p>A description of each parameter follows:</p>
 372
 373 <h5>image_info</h5>
 374 <p>the image info..</p>
 375
 376 <h5>image</h5>
 377 <p>the image.</p>
 378
 379 <h5>inject_image</h5>
 380 <p>inject into the image stream.</p>
 381
 382 <h5>format</h5>
 383 <p>the image format.</p>
 384
 385 <h5>exception</h5>
 386 <p>return any errors or warnings in this structure.</p>
 387
 388  </div>
 389 \r
 390 </div>\r
 391 \r
 392 <div id="linkbar">\r
 393     <span id="linkbar-west">&nbsp;</span>\r
 394     <span id="linkbar-center">\r
 395       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 396       <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 397     </span>\r
 398     <span id="linkbar-east">&nbsp;</span>\r
 399   </div>\r
 400   <div class="footer">\r
 401     <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>\r
 402     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 403   </div>\r
 404   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 405   <script type="text/javascript">\r
 406     var _gaq = _gaq || [];\r
 407     _gaq.push(['_setAccount', 'UA-17690367-1']);\r
 408     _gaq.push(['_trackPageview']);\r
 409 \r
 410     (function() {\r
 411       var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;\r
 412       ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';\r
 413       var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);\r
 414     })();\r
 415   </script>\r
 416 </body>\r
 417 </html>\r