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

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