NAMEblob - Read or Write Binary Large OBjects
SYNOPSISvoid AttachBlob( BlobInfo *blob_info, const void *blob, const size_t length ); MagickBooleanType BlobToFile( char *filename, const void *blob, const size_t length, ExceptionInfo *exception ); Image * BlobToImage( const ImageInfo *image_info, const void *blob, const size_t length, ExceptionInfo *exception ); BlobInfo * CloneBlobInfo( const BlobInfo *blob_info ); void DestroyBlob( Image *image ); unsigned char * DetachBlob( BlobInfo *blob_info ); unsigned char * FileToBlob( const char *filename, size_t *length, ExceptionInfo *exception ); MagickBooleanType GetBlobError( const Image *image ); FILE * GetBlobFileHandle( const Image *image ); void GetBlobInfo( BlobInfo *blob_info ); unsigned char * GetBlobStreamData( const Image *image ); StreamHandler GetBlobStreamHandler( const Image *image ); unsigned char * ImageToBlob( const ImageInfo *image_info, Image *image, size_t *length, ExceptionInfo *exception ); MagickBooleanType ImageToFile( Image *image, char *filename, ExceptionInfo *exception ); MagickBooleanType IsBlobExempt( const Image *image ); MagickBooleanType IsBlobSeekable( const Image *image ); MagickBooleanType IsBlobTemporary( const Image *image ); Image * PingBlob( const ImageInfo *image_info, const void *blob, const size_t length, ExceptionInfo *exception ); BlobInfo ReferenceBlob( BlobInfo *blob_info ); MagickBooleanType SetBlobExempt( const Image *image, const MagickBooleanType exempt );
FUNCTION DESCRIPTIONS
AttachBlobAttachBlob() attaches a blob to the BlobInfo structure. The format of the AttachBlob method is: void AttachBlob ( BlobInfo *blob_info, const void *blob, const size_t length ); A description of each parameter follows:
BlobToFileBlobToFile() writes a blob to a file. It returns MagickFalse if an error occurs otherwise MagickTrue. The format of the BlobToFile method is: MagickBooleanType BlobToFile ( char *filename, const void *blob, const size_t length, ExceptionInfo *exception ); A description of each parameter follows:
BlobToImageBlobToImage() implements direct to memory image formats. It returns the blob as an image. The format of the BlobToImage method is: Image *BlobToImage ( const ImageInfo *image_info, const void *blob, const size_t length, ExceptionInfo *exception ); A description of each parameter follows:
CloneBlobInfoCloneBlobInfo() makes a duplicate of the given blob info structure, or if blob info is NULL, a new one. The format of the CloneBlobInfo method is: BlobInfo *CloneBlobInfo ( const BlobInfo *blob_info ); A description of each parameter follows:
DestroyBlobDestroyBlob() deallocates memory associated with a blob. The format of the DestroyBlob method is: void DestroyBlob ( Image *image ); A description of each parameter follows:
DetachBlobDetachBlob() detaches a blob from the BlobInfo structure. The format of the DetachBlob method is: unsigned char *DetachBlob ( BlobInfo *blob_info ); A description of each parameter follows:
FileToBlobFileToBlob() 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. The format of the FileToBlob method is: unsigned char *FileToBlob ( const char *filename, size_t *length, ExceptionInfo *exception ); A description of each parameter follows:
GetBlobErrorGetBlobError() returns MagickTrue if the blob associated with the specified image encountered an error. The format of the GetBlobError method is: MagickBooleanType GetBlobError ( const Image *image ); A description of each parameter follows:
GetBlobFileHandleGetBlobFileHandle() returns the file handleassociated with the image blob. The format of the GetBlobFile method is: FILE *GetBlobFileHandle ( const Image *image ); A description of each parameter follows:
GetBlobInfoGetBlobInfo() initializes the BlobInfo structure. The format of the GetBlobInfo method is: void GetBlobInfo ( BlobInfo *blob_info ); A description of each parameter follows:
GetBlobStreamDataGetBlobStreamData() returns the stream data for the image. The format of the GetBlobStreamData method is: unsigned char *GetBlobStreamData ( const Image *image ); A description of each parameter follows:
GetBlobStreamHandlerGetBlobStreamHandler() returns the stream handler for the image. The format of the GetBlobStreamHandler method is: StreamHandler GetBlobStreamHandler ( const Image *image ); A description of each parameter follows:
ImageToBlobImageToBlob() implements direct to memory image formats. It returns the image as a blob and its length. The magick member of the Image structure determines the format of the returned blob ( GIF, JPEG, PNG, etc. ) The format of the ImageToBlob method is: unsigned char *ImageToBlob ( const ImageInfo *image_info, Image *image, size_t *length, ExceptionInfo *exception ); A description of each parameter follows:
ImageToFileImageToFile() writes an image to a file. It returns MagickFalse if an error occurs otherwise MagickTrue. The format of the ImageToFile method is: MagickBooleanType ImageToFile ( Image *image, char *filename, ExceptionInfo *exception ); A description of each parameter follows:
IsBlobExemptIsBlobExempt() returns true if the blob is exempt. The format of the IsBlobExempt method is: MagickBooleanType IsBlobExempt ( const Image *image ); A description of each parameter follows:
IsBlobSeekableIsBlobSeekable() returns true if the blob is seekable. The format of the IsBlobSeekable method is: MagickBooleanType IsBlobSeekable ( const Image *image ); A description of each parameter follows:
IsBlobTemporaryIsBlobTemporary() returns true if the blob is temporary. The format of the IsBlobTemporary method is: MagickBooleanType IsBlobTemporary ( const Image *image ); A description of each parameter follows:
PingBlobPingBlob() 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. The format of the PingBlob method is: Image *PingBlob ( const ImageInfo *image_info, const void *blob, const size_t length, ExceptionInfo *exception ); A description of each parameter follows:
ReferenceBlobReferenceBlob() increments the reference count associated with the pixel blob returning a pointer to the blob. The format of the ReferenceBlob method is: BlobInfo ReferenceBlob ( BlobInfo *blob_info ); A description of each parameter follows:
SetBlobExemptSetBlobExempt() sets the blob exempt status. The format of the SetBlobExempt method is: MagickBooleanType SetBlobExempt ( const Image *image, const MagickBooleanType exempt ); A description of each parameter follows:
|