Profile Handling API


Functions

int oyCheckProfile (const char *filename, const char *coloursig)
 check an file if it is a profile
int oyCheckProfileMem (const void *mem, size_t size, const char *coloursig)
 check an memory block if it is a profile
size_t oyGetProfileSize (const char *profilename)
 get the profiles size
void * oyGetProfileBlock (const char *profilename, size_t *size, oyAlloc_f allocate_func)
 obtain an memory block in the responsibility of the user
char * oyGetPathFromProfileName (const char *profile_name, oyAlloc_f allocate_func)

Detailed Description

Functions to handle profiles.

Function Documentation

int oyCheckProfile ( const char *  filename,
const char *  coloursig 
)

check an file if it is a profile

Parameters:
filename the filename to check
coloursig colour space signature as described in the ICC specification
Returns:
true/false

int oyCheckProfileMem ( const void *  mem,
size_t  size,
const char *  coloursig 
)

check an memory block if it is a profile

Parameters:
mem the memory containing the profile
size the size of the memory block
coloursig currently ignored
Returns:
true/false

char* oyGetPathFromProfileName ( const char *  profile_name,
oyAlloc_f  allocate_func 
)

Find out where in the Oyranos search path the specified profile resides.

Deprecated:
This function will be substituded by oyProfile_GetFileName.
Parameters:
profile_name the filename find in the Oyranos search path
allocate_func user provided function for allocating the string memory
Returns:
the path name where the profile was found in the Oyranos search path

void* oyGetProfileBlock ( const char *  profilename,
size_t *  size,
oyAlloc_f  allocate_func 
)

obtain an memory block in the responsibility of the user

Please note the size parameter is sensible. Eighter set it to zero or to the size obtained with oyGetProfileSize to get the full data or specify the size you want to get a partitial profile.
This feature is useful for instance to get only the headers of many profiles.

Parameters:
profilename specifies the profile
[in] size desired size, or zero for a complete copy
[out] size the size of the returned block
allocate_func the users memory allocation function
Returns:
the profile block in memory allocated by oyAlloc_f

size_t oyGetProfileSize ( const char *  profilename  ) 

get the profiles size

Parameters:
profilename specifies the profile
Returns:
size


Generated on Thu Jun 11 13:23:06 2009 for Oyranos by  doxygen 1.5.8