1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
|
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<style type="text/css"><!--
@import url("../../www/magick.css");
//--></style>
<title>ImageMagick: MagickCore, C API for ImageMagick: Read or Write Binary Large OBjects</title>
<meta http-equiv="Content-Language" content="en-US" />
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<meta http-equiv="Reply-to" content="magick-users@imagemagick.org" />
<meta name="Generator" content="PHP" />
<meta name="Keywords" content="magickcore, c, api, for, imagemagick:, read, or, write, binary, large, objects, ImageMagick, PerlMagick, Magick++, Image, Magick" />
<meta name="Description" content="ImageMagick (TM) is a free software suite to create, edit and compose bitmap images. It can read, convert and write images in a large variety of formats. Images can be cropped, colors can be changed, various effects can be applied, images can be rotated and combined, and text, lines, polygons, ellipses and Bézier curves can be added to images and stretched and rotated. ImageMagick is free software: it is delivered with full source code and can be freely used, copied, modified and distributed. Its license is compatible with the GPL. It runs on all major operating systems. Most of the functionality of ImageMagick can be used interactively from the command line; more often, however, the features are used from programs written in the programming languages Perl, C, C++, Python, PHP, Ruby or Java, for which ready-made ImageMagick interfaces (PerlMagick, Magick++, PythonMagick, MagickWand for PHP, RubyMagick, and JMagick) are available. This makes it possible to modify or create images automatically and dynamically. ImageMagick supports many image formats (over 90 major formats) including popular formats like TIFF, JPEG, PNG, PDF, PhotoCD, and GIF." />
<meta name="Rating" content="GENERAL" />
<meta name="Robots" content="ALL" />
<meta name="Generator" content="ImageMagick Studio LLC" />
<meta name="Author" content="ImageMagick Studio LLC" />
<meta name="Revisit-after" content="2 DAYS" />
<meta name="Resource-type" content="document" />
<meta name="Copyright" content="Copyright (c) 1999-2005 ImageMagick Studio LLC" />
<meta name="Distribution" content="Global" />
<link rel="shortcut icon" href="/../images/wand.ico" type="image/x-icon" />
</head>
<body id="www-imagemagick-org">
<table width="100%" id="titlebar" bgcolor="#f5f5f5" cellpadding="0" cellspacing="0" border="0" summary="ImageMagick">
<tbody>
<tr valign="top">
<td align="left"><a href="../../index.html"><img id="titlebar-west" src="../../images/script.png" alt="[ImageMagick]" width="202" height="118" border="0" name="titlebar-west" /></a></td>
<td width="35%"><br /></td>
<td align="left"><a href="http://www.imagemagick.org/" target="451850436"><img id="titlebar-west" src="../../images/sponsor.jpg" alt="[sponsor]" border="0" vspace="28" name="titlebar-west" /></a></td>
<td width="65%"><br /></td>
<td bgcolor="white" align="right"><a href="../../index.html"><img src="../../images/sprite.jpg" alt="" width="114" height="118" border="0" name="titlebar-east" /></a></td>
<td bgcolor="white" align="right"><a href="../../index.html"><img id="titlebar-east" src="../../images/logo.jpg" alt="" width="114" height="118" border="0" name="titlebar-east" /></a></td>
</tr>
</tbody>
</table>
<table width="100%" border="0" cellpadding="0" cellspacing="0" summary="">
<tbody>
<tr valign="top" style="height: 100%;">
<td id="menu" width="1%" height="100%">
<p><a href="#main">Skip to page contents</a></p>
<span>[</span>
<a href="../../index.html">About ImageMagick</a>
<a href="../../www/command-line-tools.html">Command-line Tools</a>
<a href="../../www/api.html">Program Interfaces</a>
<span>]</span><br /><span>[</span>
<a href="../../www/install-source.html">Install from Source</a>
<a href="../../www/binary-releases.html">Binary Releases</a>
<a href="../../www/resources.html">Resources</a>
<span>]</span><br /><span>[</span>
<a href="../../www/download.html">Download</a>
<span>]</span><br /><span>[</span>
<a href="../../www/links.html">Links</a>
<span>]</span><br /><br /><span>[</span>
<a href="../../www/sponsors.html">Sponsors</a>
<a href="http://www.devlib.org" class="sponsor" target="sponsor">IT and Programming<br />Resources</a><!-- 20050515 -->
<span>]</span>
</td>
<td id="main" valign="top">
<p class="navigation-index">[ <a href="#BlobToFile">BlobToFile</a> | <a href="#BlobToImage">BlobToImage</a> | <a href="#DestroyBlob">DestroyBlob</a> | <a href="#DetachBlob">DetachBlob</a> | <a href="#FileToBlob">FileToBlob</a> | <a href="#GetBlobError">GetBlobError</a> | <a href="#GetBlobFileHandle">GetBlobFileHandle</a> | <a href="#GetBlobInfo">GetBlobInfo</a> | <a href="#GetBlobStreamData">GetBlobStreamData</a> | <a href="#GetBlobStreamHandler">GetBlobStreamHandler</a> | <a href="#ImageToBlob">ImageToBlob</a> | <a href="#ImageToFile">ImageToFile</a> | <a href="#ImagesToBlob">ImagesToBlob</a> | <a href="#IsBlobExempt">IsBlobExempt</a> | <a href="#IsBlobSeekable">IsBlobSeekable</a> | <a href="#IsBlobTemporary">IsBlobTemporary</a> | <a href="#PingBlob">PingBlob</a> | <a href="#ReadBlobStream">ReadBlobStream</a> | <a href="#SetBlobExempt">SetBlobExempt</a> ]</p>
<div style="margin: auto;">
<h2><a name="BlobToFile">BlobToFile</a></h2>
</div>
<p>BlobToFile() writes a blob to a file. It returns MagickFalse if an error occurs otherwise MagickTrue.</p>
<p>The format of the BlobToFile method is:</p>
<pre class="code">
MagickBooleanType BlobToFile(char *filename,const void *blob,
const size_t length,ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p>
<h4>filename</h4>
<p>Write the blob to this file.</p>
<h4>blob</h4>
<p>The address of a blob.</p>
<h4>length</h4>
<p>This length in bytes of the blob.</p>
<h4>exception</h4>
<p>Return any errors or warnings in this structure.</p>
<div style="margin: auto;">
<h2><a name="BlobToImage">BlobToImage</a></h2>
</div>
<p>BlobToImage() implements direct to memory image formats. It returns the blob as an image.</p>
<p>The format of the BlobToImage method is:</p>
<pre class="code">
Image *BlobToImage(const ImageInfo *image_info,const void *blob,
const size_t length,ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p>
<h4>image_info</h4>
<p>The image info.</p>
<h4>blob</h4>
<p>The address of a character stream in one of the image formats understood by ImageMagick.</p>
<h4>length</h4>
<p>This size_t integer reflects the length in bytes of the blob.</p>
<h4>exception</h4>
<p>Return any errors or warnings in this structure.</p>
<div style="margin: auto;">
<h2><a name="DestroyBlob">DestroyBlob</a></h2>
</div>
<p>DestroyBlob() deallocates memory associated with a blob.</p>
<p>The format of the DestroyBlob method is:</p>
<pre class="code">
void DestroyBlob(Image *image)
</pre>
<p>A description of each parameter follows:</p>
<h4>image</h4>
<p>The image.</p>
<div style="margin: auto;">
<h2><a name="DetachBlob">DetachBlob</a></h2>
</div>
<p>DetachBlob() detaches a blob from the BlobInfo structure.</p>
<p>The format of the DetachBlob method is:</p>
<pre class="code">
unsigned char *DetachBlob(BlobInfo *blob_info)
</pre>
<p>A description of each parameter follows:</p>
<h4>blob_info</h4>
<p>Specifies a pointer to a BlobInfo structure.</p>
<div style="margin: auto;">
<h2><a name="FileToBlob">FileToBlob</a></h2>
</div>
<p>FileToBlob() returns the contents of a file as a blob. It returns the file as a blob and its length. If an error occurs, NULL is returned.</p>
<p>The format of the FileToBlob method is:</p>
<pre class="code">
unsigned char *FileToBlob(const char *filename,const size_t extent,
size_t *length,ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p>
<h4>blob</h4>
<p>FileToBlob() returns the contents of a file as a blob. If an error occurs NULL is returned.</p>
<h4>filename</h4>
<p>The filename.</p>
<h4>extent</h4>
<p>The maximum length of the blob.</p>
<h4>length</h4>
<p>On return, this reflects the actual length of the blob.</p>
<h4>exception</h4>
<p>Return any errors or warnings in this structure.</p>
<div style="margin: auto;">
<h2><a name="GetBlobError">GetBlobError</a></h2>
</div>
<p>GetBlobError() returns MagickTrue if the blob associated with the specified image encountered an error.</p>
<p>The format of the GetBlobError method is:</p>
<pre class="code">
MagickBooleanType GetBlobError(const Image *image)
</pre>
<p>A description of each parameter follows:</p>
<h4>image</h4>
<p>The image.</p>
<div style="margin: auto;">
<h2><a name="GetBlobFileHandle">GetBlobFileHandle</a></h2>
</div>
<p>GetBlobFileHandle() returns the file handleassociated with the image blob.</p>
<p>The format of the GetBlobFile method is:</p>
<pre class="code">
FILE *GetBlobFileHandle(const Image *image)
</pre>
<p>A description of each parameter follows:</p>
<h4>image</h4>
<p>The image.</p>
<div style="margin: auto;">
<h2><a name="GetBlobInfo">GetBlobInfo</a></h2>
</div>
<p>GetBlobInfo() initializes the BlobInfo structure.</p>
<p>The format of the GetBlobInfo method is:</p>
<pre class="code">
void GetBlobInfo(BlobInfo *blob_info)
</pre>
<p>A description of each parameter follows:</p>
<h4>blob_info</h4>
<p>Specifies a pointer to a BlobInfo structure.</p>
<div style="margin: auto;">
<h2><a name="GetBlobStreamData">GetBlobStreamData</a></h2>
</div>
<p>GetBlobStreamData() returns the stream data for the image.</p>
<p>The format of the GetBlobStreamData method is:</p>
<pre class="code">
unsigned char *GetBlobStreamData(const Image *image)
</pre>
<p>A description of each parameter follows:</p>
<h4>image</h4>
<p>The image.</p>
<div style="margin: auto;">
<h2><a name="GetBlobStreamHandler">GetBlobStreamHandler</a></h2>
</div>
<p>GetBlobStreamHandler() returns the stream handler for the image.</p>
<p>The format of the GetBlobStreamHandler method is:</p>
<pre class="code">
StreamHandler GetBlobStreamHandler(const Image *image)
</pre>
<p>A description of each parameter follows:</p>
<h4>image</h4>
<p>The image.</p>
<div style="margin: auto;">
<h2><a name="ImageToBlob">ImageToBlob</a></h2>
</div>
<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>
<p>The format of the ImageToBlob method is:</p>
<pre class="code">
unsigned char *ImageToBlob(const ImageInfo *image_info,Image *image,
size_t *length,ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p>
<h4>image_info</h4>
<p>The image info.</p>
<h4>image</h4>
<p>The image.</p>
<h4>length</h4>
<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>
<h4>exception</h4>
<p>Return any errors or warnings in this structure.</p>
<div style="margin: auto;">
<h2><a name="ImageToFile">ImageToFile</a></h2>
</div>
<p>ImageToFile() writes an image to a file. It returns MagickFalse if an error occurs otherwise MagickTrue.</p>
<p>The format of the ImageToFile method is:</p>
<pre class="code">
MagickBooleanType ImageToFile(Image *image,char *filename,
ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p>
<h4>image</h4>
<p>The image.</p>
<h4>filename</h4>
<p>Write the image to this file.</p>
<h4>exception</h4>
<p>Return any errors or warnings in this structure.</p>
<div style="margin: auto;">
<h2><a name="ImagesToBlob">ImagesToBlob</a></h2>
</div>
<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>
<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>
<p>The format of the ImagesToBlob method is:</p>
<pre class="code">
unsigned char *ImagesToBlob(const ImageInfo *image_info,Image *images,
size_t *length,ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p>
<h4>image_info</h4>
<p>The image info.</p>
<h4>images</h4>
<p>The image list.</p>
<h4>length</h4>
<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>
<h4>exception</h4>
<p>Return any errors or warnings in this structure.</p>
<div style="margin: auto;">
<h2><a name="IsBlobExempt">IsBlobExempt</a></h2>
</div>
<p>IsBlobExempt() returns true if the blob is exempt.</p>
<p>The format of the IsBlobExempt method is:</p>
<pre class="code">
MagickBooleanType IsBlobExempt(const Image *image)
</pre>
<p>A description of each parameter follows:</p>
<h4>image</h4>
<p>The image.</p>
<div style="margin: auto;">
<h2><a name="IsBlobSeekable">IsBlobSeekable</a></h2>
</div>
<p>IsBlobSeekable() returns true if the blob is seekable.</p>
<p>The format of the IsBlobSeekable method is:</p>
<pre class="code">
MagickBooleanType IsBlobSeekable(const Image *image)
</pre>
<p>A description of each parameter follows:</p>
<h4>image</h4>
<p>The image.</p>
<div style="margin: auto;">
<h2><a name="IsBlobTemporary">IsBlobTemporary</a></h2>
</div>
<p>IsBlobTemporary() returns true if the blob is temporary.</p>
<p>The format of the IsBlobTemporary method is:</p>
<pre class="code">
MagickBooleanType IsBlobTemporary(const Image *image)
</pre>
<p>A description of each parameter follows:</p>
<h4>image</h4>
<p>The image.</p>
<div style="margin: auto;">
<h2><a name="PingBlob">PingBlob</a></h2>
</div>
<p>PingBlob() returns all the attributes of an image or image sequence except for the pixels. It is much faster and consumes far less memory than BlobToImage(). On failure, a NULL image is returned and exception describes the reason for the failure.</p>
<p>The format of the PingBlob method is:</p>
<pre class="code">
Image *PingBlob(const ImageInfo *image_info,const void *blob,
const size_t length,ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p>
<h4>image_info</h4>
<p>The image info.</p>
<h4>blob</h4>
<p>The address of a character stream in one of the image formats understood by ImageMagick.</p>
<h4>length</h4>
<p>This size_t integer reflects the length in bytes of the blob.</p>
<h4>exception</h4>
<p>Return any errors or warnings in this structure.</p>
<div style="margin: auto;">
<h2><a name="ReadBlobStream">ReadBlobStream</a></h2>
</div>
<p>ReadBlobStream() read data from an image stream. If the stream is memory-mapped, a pointer is returned to the in-memory data otherwise the data is copied to the user supplied buffer and its location is returned.</p>
<p>The format of the ReadBlobStream method is:</p>
<pre class="code">
const unsigned char *ReadBlobStream(Image *image,const size_t length,
unsigned char *data,ssize_t *count)
</pre>
<p>A description of each parameter follows:</p>
<h4>image</h4>
<p>The image.</p>
<h4>length</h4>
<p>The number of bytes to read from the image stream.</p>
<h4>data</h4>
<p>The user supplied buffer greater or equal to length bytes.</p>
<h4>count</h4>
<p>Returns the number of bytes read.</p>
<div style="margin: auto;">
<h2><a name="SetBlobExempt">SetBlobExempt</a></h2>
</div>
<p>SetBlobExempt() sets the blob exempt status.</p>
<p>The format of the SetBlobExempt method is:</p>
<pre class="code">
MagickBooleanType SetBlobExempt(const Image *image,
const MagickBooleanType exempt)
</pre>
<p>A description of each parameter follows:</p>
<h4>image</h4>
<p>The image.</p>
<h4>exempt</h4>
<p>Set to true if this blob is exempt from being closed.</p>
</td>
<td id="margin" width="1%" height="100%" valign="top" align="right"> </td>
</tr>
</tbody>
</table>
<div id="linkbar">
<a href="http://redux.imagemagick.org/discussion-server" target="277110232">Discourse Server</a> |
<a href="../../www/mailing-list.html">Mailing Lists</a> |
<a href="http://redux.imagemagick.org/gallery" target="1978163253">Image Gallery</a> |
<a href="http://redux.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi" target="324011051">ImageMagick Studio</a>
</div>
<div>
<span id="footer-west">© 1999-2005 ImageMagick Studio LLC</span>
</div>
<div style="clear: both; margin: 0; width: 100%; "></div>
</body>
</html>
|
