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