cups/api-filedir.shtml

   1 <!--
   2   File and directory API introduction for CUPS.
   3
   4   Copyright 2007-2011 by Apple Inc.
   5   Copyright 1997-2005 by Easy Software Products, all rights reserved.
   6
   7   These coded instructions, statements, and computer programs are the
   8   property of Apple Inc. and are protected by Federal copyright
   9   law.  Distribution and use rights are outlined in the file "LICENSE.txt"
  10   which should have been included with this file.  If this file is
  11   file is missing or damaged, see the license at "http://www.cups.org/".
  12 -->
  13
  14 <h2 class='title'><a name="OVERVIEW">Overview</a></h2>
  15
  16 <p>The CUPS file and directory APIs provide portable interfaces
  17 for manipulating files and listing files and directories. Unlike
  18 stdio <code>FILE</code> streams, the <code>cupsFile</code> functions
  19 allow you to open more than 256 files at any given time. They
  20 also manage the platform-specific details of locking, large file
  21 support, line endings (CR, LF, or CR LF), and reading and writing
  22 files using Flate ("gzip") compression. Finally, you can also
  23 connect, read from, and write to network connections using the
  24 <code>cupsFile</code> functions.</p>
  25
  26 <p>The <code>cupsDir</code> functions manage the platform-specific
  27 details of directory access/listing and provide a convenient way
  28 to get both a list of files and the information (permissions,
  29 size, timestamp, etc.) for each of those files.</p>