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