<html>
<!-- SECTION: Programming -->
<head>
-<title>File and Directory APIs</title>
-<meta name="keywords" content="Programming">
-<meta name="creator" content="Mini-XML v2.6">
+ <title>File and Directory APIs </title>
+ <meta name="keywords" content="Programming">
+ <meta http-equiv="Content-Type" content="text/html;charset=utf-8">
+ <meta name="creator" content="Mini-XML v2.7">
<style type="text/css"><!--
BODY {
font-family: lucida grande, geneva, helvetica, arial, sans-serif;
}
PRE.command {
+ border: dotted thin #7f7f7f;
margin-left: 36pt;
+ padding: 10px;
}
P.compact {
background: #eeeeee;
border: dotted thin #999999;
margin-left: 36pt;
- padding: 10px;
+ padding: 10pt;
}
PRE.command EM, PRE.example EM {
}
BLOCKQUOTE {
- background: #cccccc;
+ background: #eeeeee;
border: solid thin #999999;
padding: 10pt;
}
font-size: 100%;
}
+H1.title {
+}
+
H2.title, H3.title {
border-bottom: solid 2pt #000000;
}
<body>
<div class='body'>
<!--
- "$Id: api-filedir.header 8087 2008-10-27 21:37:05Z mike $"
+ "$Id$"
File and Directory API header for the Common UNIX Printing System (CUPS).
- Copyright 2008 by Apple Inc.
+ Copyright 2008-2009 by Apple Inc.
These coded instructions, statements, and computer programs are the
property of Apple Inc. and are protected by Federal copyright
file is missing or damaged, see the license at "http://www.cups.org/".
-->
+<h1 class='title'>File and Directory APIs</h1>
+
<div class='summary'><table summary='General Information'>
<thead>
<tr>
</table></div>
<h2 class="title">Contents</h2>
<ul class="contents">
-<ul class="subcontents">
<li><a href="#OVERVIEW">Overview</a></li>
<li><a href="#FUNCTIONS">Functions</a><ul class="code">
-<li><a href="#cupsDirClose" title="Close a directory.">cupsDirClose</a></li>
-<li><a href="#cupsDirOpen" title="Open a directory.">cupsDirOpen</a></li>
-<li><a href="#cupsDirRead" title="Read the next directory entry.">cupsDirRead</a></li>
-<li><a href="#cupsDirRewind" title="Rewind to the start of the directory.">cupsDirRewind</a></li>
-<li><a href="#cupsFileClose" title="Close a CUPS file.">cupsFileClose</a></li>
-<li><a href="#cupsFileCompression" title="Return whether a file is compressed.">cupsFileCompression</a></li>
-<li><a href="#cupsFileEOF" title="Return the end-of-file status.">cupsFileEOF</a></li>
-<li><a href="#cupsFileFind" title="Find a file using the specified path.">cupsFileFind</a></li>
-<li><a href="#cupsFileFlush" title="Flush pending output.">cupsFileFlush</a></li>
-<li><a href="#cupsFileGetChar" title="Get a single character from a file.">cupsFileGetChar</a></li>
-<li><a href="#cupsFileGetConf" title="Get a line from a configuration file...">cupsFileGetConf</a></li>
-<li><a href="#cupsFileGetLine" title="Get a CR and/or LF-terminated line that may
+ <li><a href="#cupsDirClose" title="Close a directory.">cupsDirClose</a></li>
+ <li><a href="#cupsDirOpen" title="Open a directory.">cupsDirOpen</a></li>
+ <li><a href="#cupsDirRead" title="Read the next directory entry.">cupsDirRead</a></li>
+ <li><a href="#cupsDirRewind" title="Rewind to the start of the directory.">cupsDirRewind</a></li>
+ <li><a href="#cupsFileClose" title="Close a CUPS file.">cupsFileClose</a></li>
+ <li><a href="#cupsFileCompression" title="Return whether a file is compressed.">cupsFileCompression</a></li>
+ <li><a href="#cupsFileEOF" title="Return the end-of-file status.">cupsFileEOF</a></li>
+ <li><a href="#cupsFileFind" title="Find a file using the specified path.">cupsFileFind</a></li>
+ <li><a href="#cupsFileFlush" title="Flush pending output.">cupsFileFlush</a></li>
+ <li><a href="#cupsFileGetChar" title="Get a single character from a file.">cupsFileGetChar</a></li>
+ <li><a href="#cupsFileGetConf" title="Get a line from a configuration file.">cupsFileGetConf</a></li>
+ <li><a href="#cupsFileGetLine" title="Get a CR and/or LF-terminated line that may
contain binary data.">cupsFileGetLine</a></li>
-<li><a href="#cupsFileGets" title="Get a CR and/or LF-terminated line.">cupsFileGets</a></li>
-<li><a href="#cupsFileLock" title="Temporarily lock access to a file.">cupsFileLock</a></li>
-<li><a href="#cupsFileNumber" title="Return the file descriptor associated with a CUPS file.">cupsFileNumber</a></li>
-<li><a href="#cupsFileOpen" title="Open a CUPS file.">cupsFileOpen</a></li>
-<li><a href="#cupsFileOpenFd" title="Open a CUPS file using a file descriptor.">cupsFileOpenFd</a></li>
-<li><a href="#cupsFilePeekChar" title="Peek at the next character from a file.">cupsFilePeekChar</a></li>
-<li><a href="#cupsFilePrintf" title="Write a formatted string.">cupsFilePrintf</a></li>
-<li><a href="#cupsFilePutChar" title="Write a character.">cupsFilePutChar</a></li>
-<li><a href="#cupsFilePutConf" title="Write a configuration line.">cupsFilePutConf</a></li>
-<li><a href="#cupsFilePuts" title="Write a string.">cupsFilePuts</a></li>
-<li><a href="#cupsFileRead" title="Read from a file.">cupsFileRead</a></li>
-<li><a href="#cupsFileRewind" title="Set the current file position to the beginning of the
+ <li><a href="#cupsFileGets" title="Get a CR and/or LF-terminated line.">cupsFileGets</a></li>
+ <li><a href="#cupsFileLock" title="Temporarily lock access to a file.">cupsFileLock</a></li>
+ <li><a href="#cupsFileNumber" title="Return the file descriptor associated with a CUPS file.">cupsFileNumber</a></li>
+ <li><a href="#cupsFileOpen" title="Open a CUPS file.">cupsFileOpen</a></li>
+ <li><a href="#cupsFileOpenFd" title="Open a CUPS file using a file descriptor.">cupsFileOpenFd</a></li>
+ <li><a href="#cupsFilePeekChar" title="Peek at the next character from a file.">cupsFilePeekChar</a></li>
+ <li><a href="#cupsFilePrintf" title="Write a formatted string.">cupsFilePrintf</a></li>
+ <li><a href="#cupsFilePutChar" title="Write a character.">cupsFilePutChar</a></li>
+ <li><a href="#cupsFilePutConf" title="Write a configuration line.">cupsFilePutConf</a></li>
+ <li><a href="#cupsFilePuts" title="Write a string.">cupsFilePuts</a></li>
+ <li><a href="#cupsFileRead" title="Read from a file.">cupsFileRead</a></li>
+ <li><a href="#cupsFileRewind" title="Set the current file position to the beginning of the
file.">cupsFileRewind</a></li>
-<li><a href="#cupsFileSeek" title="Seek in a file.">cupsFileSeek</a></li>
-<li><a href="#cupsFileStderr" title="Return a CUPS file associated with stderr.">cupsFileStderr</a></li>
-<li><a href="#cupsFileStdin" title="Return a CUPS file associated with stdin.">cupsFileStdin</a></li>
-<li><a href="#cupsFileStdout" title="Return a CUPS file associated with stdout.">cupsFileStdout</a></li>
-<li><a href="#cupsFileTell" title="Return the current file position.">cupsFileTell</a></li>
-<li><a href="#cupsFileUnlock" title="Unlock access to a file.">cupsFileUnlock</a></li>
-<li><a href="#cupsFileWrite" title="Write to a file.">cupsFileWrite</a></li>
+ <li><a href="#cupsFileSeek" title="Seek in a file.">cupsFileSeek</a></li>
+ <li><a href="#cupsFileStderr" title="Return a CUPS file associated with stderr.">cupsFileStderr</a></li>
+ <li><a href="#cupsFileStdin" title="Return a CUPS file associated with stdin.">cupsFileStdin</a></li>
+ <li><a href="#cupsFileStdout" title="Return a CUPS file associated with stdout.">cupsFileStdout</a></li>
+ <li><a href="#cupsFileTell" title="Return the current file position.">cupsFileTell</a></li>
+ <li><a href="#cupsFileUnlock" title="Unlock access to a file.">cupsFileUnlock</a></li>
+ <li><a href="#cupsFileWrite" title="Write to a file.">cupsFileWrite</a></li>
</ul></li>
<li><a href="#TYPES">Data Types</a><ul class="code">
<li><a href="#cups_dentry_t" title="Directory entry type">cups_dentry_t</a></li>
<li><a href="#STRUCTURES">Structures</a><ul class="code">
<li><a href="#cups_dentry_s" title="Directory entry type">cups_dentry_s</a></li>
</ul></li>
+</ul>
<!--
- "$Id: api-filedir.shtml 7279 2008-01-31 01:50:44Z mike $"
+ "$Id$"
File and directory API introduction for the Common UNIX Printing System (CUPS).
<h4 class="returnvalue">Return Value</h4>
<p class="description">Character or -1 on end of file</p>
<h3 class="function"><span class="info"> CUPS 1.2/Mac OS X 10.5 </span><a name="cupsFileGetConf">cupsFileGetConf</a></h3>
-<p class="description">Get a line from a configuration file...</p>
+<p class="description">Get a line from a configuration file.</p>
<p class="code">
char *cupsFileGetConf (<br>
<a href="#cups_file_t">cups_file_t</a> *fp,<br>
</dl>
<h4 class="returnvalue">Return Value</h4>
<p class="description">0 on success, -1 on error</p>
-<h3 class="function"><span class="info"> CUPS 1.4 </span><a name="cupsFilePutConf">cupsFilePutConf</a></h3>
+<h3 class="function"><span class="info"> CUPS 1.4/Mac OS X 10.6 </span><a name="cupsFilePutConf">cupsFilePutConf</a></h3>
<p class="description">Write a configuration line.</p>
<p class="code">
ssize_t cupsFilePutConf (<br>