NAME

ilEFSListFileTypes() − return the number and handles of supported EFS file types

SYNOPSIS

ilBool
ilEFSListFileTypes (

ilContext context,

int *pNFileTypes,

ilEFSFileType **pFileTypes);

DESCRIPTION

ilEFSListFileTypes() returns the number of EFS file types supported and the EFS file type objects.  This function is provided so that a client can obtain file type information via ilGetFileTypeInfo() which can be used, for example, for a menu of supported file types.  This function is not needed for reading or writing EFS images. 

context identifies a context created by IL_CREATE_CONTEXT(). 

*pNFileTypes receives the number of supported file types

**pFileTypes receives a pointer to an array of EFS file type objects (ilEFSFileType data structures); the array is *pNFileTypes long.  Space for the array is allocated on the heap using malloc(); when done with this array, the caller should use free() on *pFileType. 

RETURN VALUE

Upon successful completion, ilEFSListFileTypes() returns TRUE.  Successful completion includes when *pNFiles is 0. 

ERRORS

If the call fails, context->error receives a non-zero error code. 

EXAMPLE

The following example gets a list of file types supported by EFS. 

ilContext context;

int nFileTypes

ilEFSFileType fileTypeList[];
.
.
.

if (!ilEFSListFileTypes(context, &nFileTypes, &fileTypeList))

return (context->error);

AUTHOR

ilEFSListFileTypes() was developed by HP. 

SEE ALSO

IL_CREATE_CONTEXT(3X), ilEFSGetFileTypeInfo(3X), free(3C), malloc(3C). 

Using the Image Developer’s Kit.

Hewlett-Packard Company  —  Image Library: February, 1995