cups/api-filedir.shtml

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