IM: Image Storage

IM - Imaging Libray

previous page next page

Image Storage

Detailed Description

See im.h

Modules

group  File Format SDK
group  Read Access
group  Write Access
group  File Formats

Data Structures

class  imImageFile
 C++ Wrapper for the Image File Structure. More...

Enumerations

enum  imErrorCodes {
  IM_ERR_NONE, IM_ERR_OPEN, IM_ERR_ACCESS, IM_ERR_FORMAT,
  IM_ERR_DATA, IM_ERR_COMPRESS, IM_ERR_MEM, IM_ERR_COUNTER
}

Functions

void imFileClose (imFile *ifile)
void * imFileHandle (imFile *ifile)
void imFileSetAttribute (imFile *ifile, const char *attrib, int data_type, int count, const void *data)
const void * imFileGetAttribute (imFile *ifile, const char *attrib, int *data_type, int *count)
void imFileGetAttributeList (imFile *ifile, char **attrib, int *attrib_count)

Enumeration Type Documentation

enum imErrorCodes
 

File Access Error Codes

Enumeration values:
IM_ERR_NONE  No error.
IM_ERR_OPEN  Error while opening the file (read or write).
IM_ERR_ACCESS  Error while accessing the file (read or write).
IM_ERR_FORMAT  Invalid or unrecognized file format.
IM_ERR_DATA  Invalid or unsupported data.
IM_ERR_COMPRESS  Invalid or unsupported compression.
IM_ERR_MEM  Insuficient memory
IM_ERR_COUNTER  Interrupted by the counter 
00061 {
00062   IM_ERR_NONE,     /**< No error. */
00063   IM_ERR_OPEN,     /**< Error while opening the file (read or write). */
00064   IM_ERR_ACCESS,   /**< Error while accessing the file (read or write). */
00065   IM_ERR_FORMAT,   /**< Invalid or unrecognized file format. */
00066   IM_ERR_DATA,     /**< Invalid or unsupported data. */
00067   IM_ERR_COMPRESS, /**< Invalid or unsupported compression. */
00068   IM_ERR_MEM,      /**< Insuficient memory */
00069   IM_ERR_COUNTER   /**< Interrupted by the counter */
00070 };

Function Documentation

void imFileClose (  imFile *  ifile  ) 
 

Closes the file

void* imFileHandle (  imFile *  ifile  ) 
 

Returns the internal handle. It is file format dependent.

void imFileSetAttribute (  imFile *  ifile,
const char *  attrib,
int  data_type,
int  count,
const void *  data
) 
 

Changes an extended attribute.
The data will be internally duplicated.
If data is NULL the attribute is removed.

const void* imFileGetAttribute (  imFile *  ifile,
const char *  attrib,
int *  data_type,
int *  count
) 
 

Returns an extended attribute.
Returns NULL if not found. data_type and count can be NULL.

void imFileGetAttributeList (  imFile *  ifile,
char **  attrib,
int *  attrib_count
) 
 

Returns a list of the attribute names.
"attrib" must contain room enough for "attrib_count" names. Use "attrib=NULL" to return only the count.


previous page start next page