]> git.ipfire.org Git - thirdparty/cups.git/blame - cups/api-filedir.shtml
Remove all of the Subversion keywords from various source files.
[thirdparty/cups.git] / cups / api-filedir.shtml
CommitLineData
ef416fc2 1<!--
eac3a0a0 2 File and directory API introduction for CUPS.
ef416fc2 3
eac3a0a0 4 Copyright 2007-2011 by Apple Inc.
bc44d920 5 Copyright 1997-2005 by Easy Software Products, all rights reserved.
ef416fc2 6
7 These coded instructions, statements, and computer programs are the
bc44d920 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/".
ef416fc2 12-->
13
5a738aea 14<h2 class='title'><a name="OVERVIEW">Overview</a></h2>
ef416fc2 15
16<p>The CUPS file and directory APIs provide portable interfaces
17for manipulating files and listing files and directories. Unlike
5a738aea 18stdio <code>FILE</code> streams, the <code>cupsFile</code> functions
ef416fc2 19allow you to open more than 256 files at any given time. They
20also manage the platform-specific details of locking, large file
21support, line endings (CR, LF, or CR LF), and reading and writing
22files using Flate ("gzip") compression. Finally, you can also
23connect, read from, and write to network connections using the
5a738aea 24<code>cupsFile</code> functions.</p>
ef416fc2 25
5a738aea 26<p>The <code>cupsDir</code> functions manage the platform-specific
ef416fc2 27details of directory access/listing and provide a convenient way
28to get both a list of files and the information (permissions,
29size, timestamp, etc.) for each of those files.</p>