cups/api-array.shtml

   1 <!--
   2   "$Id$"
   3
   4   Array API introduction for the Common UNIX Printing System (CUPS).
   5
   6   Copyright 1997-2005 by Easy Software Products.
   7
   8   These coded instructions, statements, and computer programs are the
   9   property of Easy Software Products and are protected by Federal
  10   copyright law.  Distribution and use rights are outlined in the file
  11   "LICENSE.txt" which should have been included with this file.  If this
  12   file is missing or damaged please contact Easy Software Products
  13   at:
  14
  15       Attn: CUPS Licensing Information
  16       Easy Software Products
  17       44141 Airport View Drive, Suite 204
  18       Hollywood, Maryland 20636 USA
  19
  20       Voice: (301) 373-9600
  21       EMail: cups-info@cups.org
  22         WWW: http://www.cups.org
  23 -->
  24
  25 <h2 class='title'>Introduction</h2>
  26
  27 <p>The CUPS array API provides a high-performance generic array
  28 container. The contents of the array container can be sorted and
  29 the container itself is designed for optimal speed and memory
  30 usage under a wide variety of conditions.</p>
  31
  32 <p>The CUPS scheduler (<tt>cupsd</tt>) and many of the CUPS API
  33 functions use the array API to efficiently manage large lists of
  34 data.</p>
  35
  36 <h2 class='title'>General Usage</h2>
  37
  38 <p>The <var>&lt;cups/array.h&gt;</var> header file must be
  39 included to use the <tt>cupsArray</tt> functions.</p>
  40
  41 <p>Programs using these functions must be linked to the CUPS
  42 library: <var>libcups.a</var>, <var>libcups.so.2</var>,
  43 <var>libcups.2.dylib</var>, <var>libcups_s.a</var>, or
  44 <var>libcups2.lib</var> depending on the platform. The following
  45 command compiles <var>myprogram.c</var> using GCC and the CUPS
  46 library:</p>
  47
  48 <pre class='command'>
  49 <kbd>gcc -o myprogram myprogram.c -lcups</kbd>
  50 </pre>
  51
  52 <h2 class='title'>Compatibility</h2>
  53
  54 <p>All of these functions require CUPS 1.2 or higher.</p>