Documentation
Login 
CUPS Book DDK Printer Drivers ESP Ghostscript Forums Links Windows
IntroductionThe CUPS array API provides a high-performance generic array container. The contents of the array container can be sorted and the container itself is designed for optimal speed and memory usage under a wide variety of conditions. The CUPS scheduler (cupsd) and many of the CUPS API functions use the array API to efficiently manage large lists of data. General UsageThe <cups/array.h> header file must be included to use the cupsArray functions. Programs using these functions must be linked to the CUPS library: libcups.a, libcups.so.2, libcups.2.dylib, libcups_s.a, or libcups2.lib depending on the platform. The following command compiles myprogram.c using GCC and the CUPS library: gcc -o myprogram myprogram.c -lcups CompatibilityAll of these functions require CUPS 1.2 or higher. ContentsFunctions
cupsArrayAdd()DescriptionAdd an element to the array. When adding an element to a sorted array, non-unique elements are appended at the end of the run. For unsorted arrays, the element is inserted at the end of the array. Syntax
int Arguments
Returns1 on success, 0 on failure cupsArrayClear()DescriptionClear the array. Syntax
void Arguments
ReturnsNothing. cupsArrayCount()DescriptionGet the number of elements in the array. Syntax
int Arguments
ReturnsNumber of elements cupsArrayCurrent()DescriptionReturn the current element in the array. Syntax
void * Arguments
ReturnsElement cupsArrayDelete()DescriptionFree all memory used by the array. Syntax
void Arguments
ReturnsNothing. cupsArrayDup()DescriptionDuplicate the array. Syntax
cups_array_t * Arguments
ReturnsDuplicate array cupsArrayFind()DescriptionFind an element in the array. Syntax
void * Arguments
ReturnsElement found or NULL cupsArrayFirst()DescriptionGet the first element in the array. Syntax
void * Arguments
ReturnsFirst element or NULL CUPS 1.3 cupsArrayGetIndex()DescriptionGet the index of the current element. Syntax
int Arguments
ReturnsIndex of the current element CUPS 1.3 cupsArrayGetInsert()DescriptionGet the index of the last inserted element. Syntax
int Arguments
ReturnsIndex of the last inserted element cupsArrayIndex()DescriptionGet the N-th element in the array. Syntax
void * Arguments
ReturnsN-th element or NULL cupsArrayInsert()DescriptionInsert an element in the array. When inserting an element in a sorted array, non-unique elements are inserted at the beginning of the run. For unsorted arrays, the element is inserted at the beginning of the array. Syntax
int Arguments
Returns0 on failure, 1 on success cupsArrayLast()DescriptionGet the last element in the array. Syntax
void * Arguments
ReturnsLast element or NULL cupsArrayNew()DescriptionCreate a new array. Syntax
cups_array_t * Arguments
ReturnsArray CUPS 1.3 cupsArrayNew2()DescriptionCreate a new array with hash. Syntax
cups_array_t * Arguments
ReturnsArray cupsArrayNext()DescriptionGet the next element in the array. Syntax
void * Arguments
ReturnsNext element or NULL cupsArrayPrev()DescriptionGet the previous element in the array. Syntax
void * Arguments
ReturnsPrevious element or NULL cupsArrayRemove()DescriptionRemove an element from the array. Syntax
int Arguments
Returns1 on success, 0 on failure cupsArrayRestore()DescriptionReset the current element to the last cupsArraySave. Syntax
void * Arguments
ReturnsNew current element cupsArraySave()DescriptionMark the current element for a later cupsArrayRestore. The save/restore stack is guaranteed to be at least 32 elements deep. Syntax
int Arguments
Returns1 on success, 0 on failure cupsArrayUserData()DescriptionReturn the user data for an array. Syntax
void * Arguments
ReturnsUser data Typescups_ahash_func_tDescriptionArray hash function Definitiontypedef int (*cups_ahash_func_t)(void *element, void *data); cups_array_func_tDescriptionArray comparison function Definitiontypedef int (*cups_array_func_t)(void *first, void *second, void *data); cups_array_tDescriptionCUPS array type Definitiontypedef struct _cups_array_s cups_array_t; |
Comments are owned by the poster. All other content is copyright 2007-2008 by Apple Inc. CUPS, the Common UNIX Printing System, and the CUPS logo are the trademark property of Apple Inc. All other trademarks are the property of their respective owners. Please report site problems to 'webmaster@cups.org'.
