list - Image list support

- NAME
- SYNOPSIS
- FUNCTION DESCRIPTIONS

- AppendImageToList
- CloneImageList
- DeleteImageFromList
- DestroyImageList
- GetFirstImageInList
- GetImageFromList
- GetImageIndexInList
- GetImageListLength
- GetLastImageInList
- GetNextImageInList
- GetPreviousImageInList
- ImageListToArray
- InsertImageInList
- NewImageList
- PrependImageToList
- RemoveFirstImageFromList
- RemoveLastImageFromList
- ReplaceImageInList
- ReverseImageList
- SpliceImageIntoList
- SplitImageList

# NAME

list - Image list support

# SYNOPSIS

AppendImageToList( Image *images, Image *image );

Image * CloneImageList( const Image *images, ExceptionInfo *exception );

DeleteImageFromList( Image ** images );

void DestroyImageList( Image *image );

Image * GetFirstImageInList( const Image *images );

Image * GetImageFromList( const Image *images, const long offset );

long GetImageIndexInList( const Image *images );

unsigned long GetImageListLength( const Image *images );

Image * GetLastImageInList( const Image *images );

Image * GetNextImageInList( const Image *images );

Image * GetPreviousImageInList( const Image *images );

Image ** ImageListToArray( const Image *images, ExceptionInfo *exception );

InsertImageInList( Image ** images, Image *image );

Image * NewImageList( void );

PrependImageToList( Image *images, Image *image );

Image * RemoveFirstImageFromList( Image ** images );

Image * RemoveLastImageFromList( Image ** images );

ReplaceImageInList( Image ** images, Image *image );

ReverseImageList( const Image ** images );

SpliceImageIntoList( Image ** images, const unsigned long length, Image *splice );

Image * SplitImageList( Image *images );

# FUNCTION DESCRIPTIONS

## AppendImageToList

> AppendImageToList() appends an image to the end of the list.

The format of the AppendImageToList method is:

> AppendImageToList ( Image *images, Image *image );

A description of each parameter follows:

images:

  The image list.

image:

  The image.

## CloneImageList

> CloneImageList() returns a duplicate of the image list.

The format of the CloneImageList method is:

> Image *CloneImageList ( const Image *images, ExceptionInfo *exception );

A description of each parameter follows:

images:

  The image list.

exception:

  Return any errors or warnings in this structure.

## DeleteImageFromList

> DeleteImageFromList() deletes an image from the list.

The format of the DeleteImageFromList method is:

> DeleteImageFromList ( Image **images );

A description of each parameter follows:

images:

  The image list.

## DestroyImageList

> DestroyImageList() destroys an image list.

The format of the DestroyImageList method is:

> void DestroyImageList ( Image *image );

A description of each parameter follows:

image:

  The image sequence.

## GetFirstImageInList

> GetFirstImageInList() returns a pointer to the first image in the list

The format of the GetFirstImageInList method is:

> Image *GetFirstImageInList ( const Image *images );

A description of each parameter follows:

images:

  The image list.

## GetImageFromList

> GetImageFromList() returns an image at the specified offset from the list.

The format of the GetImageFromList method is:

> Image *GetImageFromList ( const Image *images, const long offset );

A description of each parameter follows:

images:

  The image list.

offset:

  The position within the list.

## GetImageIndexInList

> GetImageIndexInList() returns the offset in the list of the specified image.

The format of the GetImageIndexInList method is:

> long GetImageIndexInList ( const Image *images );

A description of each parameter follows:

images:

  The image list.

## GetImageListLength

> GetImageListLength() returns the length of the list ( the number of images in the list ) .

The format of the GetImageListLength method is:

> unsigned long GetImageListLength ( const Image *images );

A description of each parameter follows:

images:

  The image list.

## GetLastImageInList

> GetLastImageInList() returns a pointer to the last image in the list

The format of the GetLastImageInList method is:

> Image *GetLastImageInList ( const Image *images );

A description of each parameter follows:

images:

  The image list.

## GetNextImageInList

> GetNextImageInList() returns the next image in the list.

The format of the GetNextImageInList method is:

> Image *GetNextImageInList ( const Image *images );

A description of each parameter follows:

images:

  The image list.

## GetPreviousImageInList

> GetPreviousImageInList() returns the previous image in the list.

The format of the GetPreviousImageInList method is:

> Image *GetPreviousImageInList ( const Image *images );

A description of each parameter follows:

images:

  The image list.

## ImageListToArray

> ImageListToArray() is a convenience method that converts an image list to a sequential array. For example,

> group = ImageListToArray ( images, exception ); for ( i = 0; i < n; i++ ) puts ( group[i]->filename ) ;;

The format of the ImageListToArray method is:

> Image **ImageListToArray ( const Image *images, ExceptionInfo *exception );

A description of each parameter follows:

image:

  The image list.

exception:

  Return any errors or warnings in this structure.

## InsertImageInList

> InsertImageInList() inserts an image in the list.

The format of the InsertImageInList method is:

> InsertImageInList ( Image **images, Image *image );

A description of each parameter follows:

images:

  The image list.

image:

  The image.

## NewImageList

> NewImageList() creates an empty image list.

The format of the NewImageList method is:

> Image *NewImageList ( void );

## PrependImageToList

> PrependImageToList() prepends the image to the beginning of the list.

The format of the PrependImageToList method is:

> PrependImageToList ( Image *images, Image *image );

A description of each parameter follows:

images:

  The image list.

image:

  The image.

## RemoveFirstImageFromList

> RemoveFirstImageFromList() removes an image from the beginning of the list.

The format of the RemoveFirstImageFromList method is:

> Image *RemoveFirstImageFromList ( Image **images );

A description of each parameter follows:

images:

  The image list.

## RemoveLastImageFromList

> RemoveLastImageFromList() removes the last image from the list.

The format of the RemoveLastImageFromList method is:

> Image *RemoveLastImageFromList ( Image **images );

A description of each parameter follows:

images:

  The image list.

## ReplaceImageInList

> ReplaceImageInList() replaces an image in the list.

The format of the ReplaceImageInList method is:

> ReplaceImageInList ( Image **images, Image *image );

A description of each parameter follows:

images:

  The image list.

image:

  The image.

## ReverseImageList

> ReverseImageList() reverses the image list.

The format of the ReverseImageList method is:

> ReverseImageList ( const Image **images );

A description of each parameter follows:

images:

  The image list.

## SpliceImageIntoList

> SpliceImageIntoList() removes 'length' images from the list and replaces them with the specified splice.

The format of the SpliceImageIntoList method is:

> SpliceImageIntoList ( Image **images, const unsigned long length, Image *splice );

A description of each parameter follows:

images:

  The image list.

length:

  The length of the image list to remove.

splice:

  Replace the removed image list with this list.

## SplitImageList

> SplitImageList() splits an image into two lists.

The format of the SplitImageList method is:

> Image *SplitImageList ( Image *images );

A description of each parameter follows:

images:

  The image list.