1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
<html>
<!-- SECTION: Programming -->
<head>
<title>File and Directory APIs</title>
<meta name='keywords' content='Programming'>
<meta name='creator' content='Mini-XML v2.3'>
<style type='text/css'><!--
h1, h2, h3, p { font-family: sans-serif; text-align: justify; }
tt, pre a:link, pre a:visited, tt a:link, tt a:visited { font-weight: bold; color: #7f0000; }
pre { font-weight: bold; color: #7f0000; margin-left: 2em; }
span.info { background: #000000; border: solid thin #000000; color: #ffffff; font-size: 80%; font-style: italic; font-weight: bold; white-space: nowrap; }
h3 span.info { float: right; font-size: 100%; }
h1.title, h2.title, h3.title { border-bottom: solid 2px #000000; }
--></style>
</head>
<body>
<!--
"$Id: api-filedir.html 177 2006-06-21 00:20:03Z jlovell $"
File and directory API introduction for the Common UNIX Printing System (CUPS).
Copyright 1997-2005 by Easy Software Products.
These coded instructions, statements, and computer programs are the
property of Easy Software Products and are protected by Federal
copyright law. Distribution and use rights are outlined in the file
"LICENSE.txt" which should have been included with this file. If this
file is missing or damaged please contact Easy Software Products
at:
Attn: CUPS Licensing Information
Easy Software Products
44141 Airport View Drive, Suite 204
Hollywood, Maryland 20636 USA
Voice: (301) 373-9600
EMail: cups-info@cups.org
WWW: http://www.cups.org
-->
<h2 class='title'>Introduction</h2>
<p>The CUPS file and directory APIs provide portable interfaces
for manipulating files and listing files and directories. Unlike
stdio <tt>FILE</tt> streams, the <tt>cupsFile</tt> functions
allow you to open more than 256 files at any given time. They
also manage the platform-specific details of locking, large file
support, line endings (CR, LF, or CR LF), and reading and writing
files using Flate ("gzip") compression. Finally, you can also
connect, read from, and write to network connections using the
<tt>cupsFile</tt> functions.</p>
<p>The <tt>cupsDir</tt> functions manage the platform-specific
details of directory access/listing and provide a convenient way
to get both a list of files and the information (permissions,
size, timestamp, etc.) for each of those files.</p>
<p>The CUPS scheduler (<tt>cupsd</tt>), <tt>mailto</tt> notifier,
and many of the CUPS API functions use these functions for
everything except console (stdin, stdout, stderr) I/O.</p>
<h2 class='title'>General Usage</h2>
<p>The <var><cups/dir.h></var> and
<var><cups/file.h></var> header files must be included to
use the <tt>cupsDir</tt> and <tt>cupsFile</tt> functions,
respectively.</p>
<p>Programs using these functions must be linked to the CUPS
library: <var>libcups.a</var>, <var>libcups.so.2</var>,
<var>libcups.2.dylib</var>, <var>libcups_s.a</var>, or
<var>libcups2.lib</var> depending on the platform. The following
command compiles <var>myprogram.c</var> using GCC and the CUPS
library:</p>
<pre class='command'>
<kbd>gcc -o myprogram myprogram.c -lcups</kbd>
</pre>
<h2 class='title'>Compatibility</h2>
<p>All of these functions require CUPS 1.2 or higher.</p>
<h2 class='title'>Contents</h2>
<ul>
<li><a href='#FUNCTIONS'>Functions</a></li>
<li><a href='#STRUCTURES'>Structures</a></li>
<li><a href='#TYPES'>Types</a></li>
</ul>
<!-- NEW PAGE -->
<h2 class='title'><a name='FUNCTIONS'>Functions</a></h2>
<ul>
<li><a href='#cupsDirClose'><tt>cupsDirClose()</tt></a> </li>
<li><a href='#cupsDirOpen'><tt>cupsDirOpen()</tt></a> </li>
<li><a href='#cupsDirRead'><tt>cupsDirRead()</tt></a> </li>
<li><a href='#cupsDirRewind'><tt>cupsDirRewind()</tt></a> </li>
<li><a href='#cupsFileClose'><tt>cupsFileClose()</tt></a> </li>
<li><a href='#cupsFileCompression'><tt>cupsFileCompression()</tt></a> </li>
<li><a href='#cupsFileEOF'><tt>cupsFileEOF()</tt></a> </li>
<li><a href='#cupsFileFind'><tt>cupsFileFind()</tt></a> </li>
<li><a href='#cupsFileFlush'><tt>cupsFileFlush()</tt></a> </li>
<li><a href='#cupsFileGetChar'><tt>cupsFileGetChar()</tt></a> </li>
<li><a href='#cupsFileGetConf'><tt>cupsFileGetConf()</tt></a> </li>
<li><a href='#cupsFileGetLine'><tt>cupsFileGetLine()</tt></a> </li>
<li><a href='#cupsFileGets'><tt>cupsFileGets()</tt></a> </li>
<li><a href='#cupsFileLock'><tt>cupsFileLock()</tt></a> </li>
<li><a href='#cupsFileNumber'><tt>cupsFileNumber()</tt></a> </li>
<li><a href='#cupsFileOpen'><tt>cupsFileOpen()</tt></a> </li>
<li><a href='#cupsFileOpenFd'><tt>cupsFileOpenFd()</tt></a> </li>
<li><a href='#cupsFilePeekChar'><tt>cupsFilePeekChar()</tt></a> </li>
<li><a href='#cupsFilePrintf'><tt>cupsFilePrintf()</tt></a> </li>
<li><a href='#cupsFilePutChar'><tt>cupsFilePutChar()</tt></a> </li>
<li><a href='#cupsFilePuts'><tt>cupsFilePuts()</tt></a> </li>
<li><a href='#cupsFileRead'><tt>cupsFileRead()</tt></a> </li>
<li><a href='#cupsFileRewind'><tt>cupsFileRewind()</tt></a> </li>
<li><a href='#cupsFileSeek'><tt>cupsFileSeek()</tt></a> </li>
<li><a href='#cupsFileStderr'><tt>cupsFileStderr()</tt></a> </li>
<li><a href='#cupsFileStdin'><tt>cupsFileStdin()</tt></a> </li>
<li><a href='#cupsFileStdout'><tt>cupsFileStdout()</tt></a> </li>
<li><a href='#cupsFileTell'><tt>cupsFileTell()</tt></a> </li>
<li><a href='#cupsFileUnlock'><tt>cupsFileUnlock()</tt></a> </li>
<li><a href='#cupsFileWrite'><tt>cupsFileWrite()</tt></a> </li>
</ul>
<!-- NEW PAGE -->
<h3 class='title'><a name='cupsDirClose'>cupsDirClose()</a></h3>
<h4>Description</h4>
<p>Close a directory.</p>
<h4>Syntax</h4>
<pre>
void
cupsDirClose(
<a href='#cups_dir_t'>cups_dir_t</a> * dp);
</pre>
<h4>Arguments</h4>
<div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
<thead><tr><th>Name</th><th>Description</th></tr></thead>
<tbody>
<tr><td><tt>dp</tt></td><td>Directory</td></tr>
</tbody></table></div>
<h4>Returns</h4>
<p>Nothing.</p>
<!-- NEW PAGE -->
<h3 class='title'><a name='cupsDirOpen'>cupsDirOpen()</a></h3>
<h4>Description</h4>
<p>Open a directory.</p>
<h4>Syntax</h4>
<pre>
<a href='#cups_dir_t'>cups_dir_t</a> *
cupsDirOpen(
const char * directory);
</pre>
<h4>Arguments</h4>
<div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
<thead><tr><th>Name</th><th>Description</th></tr></thead>
<tbody>
<tr><td><tt>directory</tt></td><td>Directory name</td></tr>
</tbody></table></div>
<h4>Returns</h4>
<p>Directory</p>
<!-- NEW PAGE -->
<h3 class='title'><a name='cupsDirRead'>cupsDirRead()</a></h3>
<h4>Description</h4>
<p>Read the next directory entry.</p>
<h4>Syntax</h4>
<pre>
<a href='#cups_dentry_t'>cups_dentry_t</a> *
cupsDirRead(
<a href='#cups_dir_t'>cups_dir_t</a> * dp);
</pre>
<h4>Arguments</h4>
<div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
<thead><tr><th>Name</th><th>Description</th></tr></thead>
<tbody>
<tr><td><tt>dp</tt></td><td>Directory</td></tr>
</tbody></table></div>
<h4>Returns</h4>
<p>Directory entry</p>
<!-- NEW PAGE -->
<h3 class='title'><a name='cupsDirRewind'>cupsDirRewind()</a></h3>
<h4>Description</h4>
<p>Rewind to the start of the directory.</p>
<h4>Syntax</h4>
<pre>
void
cupsDirRewind(
<a href='#cups_dir_t'>cups_dir_t</a> * dp);
</pre>
<h4>Arguments</h4>
<div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
<thead><tr><th>Name</th><th>Description</th></tr></thead>
<tbody>
<tr><td><tt>dp</tt></td><td>Directory</td></tr>
</tbody></table></div>
<h4>Returns</h4>
<p>Nothing.</p>
<!-- NEW PAGE -->
<h3 class='title'><a name='cupsFileClose'>cupsFileClose()</a></h3>
<h4>Description</h4>
<p>Close a CUPS file.</p>
<h4>Syntax</h4>
<pre>
int
cupsFileClose(
<a href='#cups_file_t'>cups_file_t</a> * fp);
</pre>
<h4>Arguments</h4>
<div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
<thead><tr><th>Name</th><th>Description</th></tr></thead>
<tbody>
<tr><td><tt>fp</tt></td><td>CUPS file</td></tr>
</tbody></table></div>
<h4>Returns</h4>
<p>0 on success, -1 on error</p>
<!-- NEW PAGE -->
<h3 class='title'><a name='cupsFileCompression'>cupsFileCompression()</a></h3>
<h4>Description</h4>
<p>Return whether a file is compressed.</p>
<h4>Syntax</h4>
<pre>
int
cupsFileCompression(
<a href='#cups_file_t'>cups_file_t</a> * fp);
</pre>
<h4>Arguments</h4>
<div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
<thead><tr><th>Name</th><th>Description</th></tr></thead>
<tbody>
<tr><td><tt>fp</tt></td><td>CUPS file</td></tr>
</tbody></table></div>
<h4>Returns</h4>
<p>CUPS_FILE_NONE or CUPS_FILE_GZIP</p>
<!-- NEW PAGE -->
<h3 class='title'><a name='cupsFileEOF'>cupsFileEOF()</a></h3>
<h4>Description</h4>
<p>Return the end-of-file status.</p>
<h4>Syntax</h4>
<pre>
int
cupsFileEOF(
<a href='#cups_file_t'>cups_file_t</a> * fp);
</pre>
<h4>Arguments</h4>
<div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
<thead><tr><th>Name</th><th>Description</th></tr></thead>
<tbody>
<tr><td><tt>fp</tt></td><td>CUPS file</td></tr>
</tbody></table></div>
<h4>Returns</h4>
<p>1 on EOF, 0 otherwise</p>
<!-- NEW PAGE -->
<h3 class='title'><a name='cupsFileFind'>cupsFileFind()</a></h3>
<h4>Description</h4>
<p>Find a file using the specified path.
This function allows the paths in the path string to be separated by
colons (UNIX standard) or semicolons (Windows standard) and stores the
result in the buffer supplied. If the file cannot be found in any of
the supplied paths, NULL is returned. A NULL path only matches the
current directory.</p>
<h4>Syntax</h4>
<pre>
const char *
cupsFileFind(
const char * filename,
const char * path,
int executable,
char * buffer,
int bufsize);
</pre>
<h4>Arguments</h4>
<div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
<thead><tr><th>Name</th><th>Description</th></tr></thead>
<tbody>
<tr><td><tt>filename</tt></td><td>File to find</td></tr>
<tr><td><tt>path</tt></td><td>Colon/semicolon-separated path</td></tr>
<tr><td><tt>executable</tt></td><td>1 = executable files, 0 = any file/dir</td></tr>
<tr><td><tt>buffer</tt></td><td>Filename buffer</td></tr>
<tr><td><tt>bufsize</tt></td><td>Size of filename buffer</td></tr>
</tbody></table></div>
<h4>Returns</h4>
<p>Full path to file or NULL</p>
<!-- NEW PAGE -->
<h3 class='title'><a name='cupsFileFlush'>cupsFileFlush()</a></h3>
<h4>Description</h4>
<p>Flush pending output.</p>
<h4>Syntax</h4>
<pre>
int
cupsFileFlush(
<a href='#cups_file_t'>cups_file_t</a> * fp);
</pre>
<h4>Arguments</h4>
<div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
<thead><tr><th>Name</th><th>Description</th></tr></thead>
<tbody>
<tr><td><tt>fp</tt></td><td>CUPS file</td></tr>
</tbody></table></div>
<h4>Returns</h4>
<p>0 on success, -1 on error</p>
<!-- NEW PAGE -->
<h3 class='title'><a name='cupsFileGetChar'>cupsFileGetChar()</a></h3>
<h4>Description</h4>
<p>Get a single character from a file.</p>
<h4>Syntax</h4>
<pre>
int
cupsFileGetChar(
<a href='#cups_file_t'>cups_file_t</a> * fp);
</pre>
<h4>Arguments</h4>
<div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
<thead><tr><th>Name</th><th>Description</th></tr></thead>
<tbody>
<tr><td><tt>fp</tt></td><td>CUPS file</td></tr>
</tbody></table></div>
<h4>Returns</h4>
<p>Character or -1 on EOF</p>
<!-- NEW PAGE -->
<h3 class='title'><a name='cupsFileGetConf'>cupsFileGetConf()</a></h3>
<h4>Description</h4>
<p>Get a line from a configuration file...</p>
<h4>Syntax</h4>
<pre>
char *
cupsFileGetConf(
<a href='#cups_file_t'>cups_file_t</a> * fp,
char * buf,
size_t buflen,
char ** value,
int * linenum);
</pre>
<h4>Arguments</h4>
<div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
<thead><tr><th>Name</th><th>Description</th></tr></thead>
<tbody>
<tr><td><tt>fp</tt></td><td>CUPS file</td></tr>
<tr><td><tt>buf</tt></td><td>String buffer</td></tr>
<tr><td><tt>buflen</tt></td><td>Size of string buffer</td></tr>
<tr><td><tt>value</tt></td><td>Pointer to value</td></tr>
<tr><td><tt>linenum</tt></td><td>Current line number</td></tr>
</tbody></table></div>
<h4>Returns</h4>
<p>Line read or NULL on eof/error</p>
<!-- NEW PAGE -->
<h3 class='title'><a name='cupsFileGetLine'>cupsFileGetLine()</a></h3>
<h4>Description</h4>
<p>Get a CR and/or LF-terminated line that may
contain binary data.
This function differs from cupsFileGets() in that the trailing CR and LF
are preserved, as is any binary data on the line. The buffer is nul-
terminated, however you should use the returned length to determine
the number of bytes on the line.</p>
<h4>Syntax</h4>
<pre>
size_t
cupsFileGetLine(
<a href='#cups_file_t'>cups_file_t</a> * fp,
char * buf,
size_t buflen);
</pre>
<h4>Arguments</h4>
<div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
<thead><tr><th>Name</th><th>Description</th></tr></thead>
<tbody>
<tr><td><tt>fp</tt></td><td>File to read from</td></tr>
<tr><td><tt>buf</tt></td><td>Buffer</td></tr>
<tr><td><tt>buflen</tt></td><td>Size of buffer</td></tr>
</tbody></table></div>
<h4>Returns</h4>
<p>Number of bytes on line or 0 on EOF</p>
<!-- NEW PAGE -->
<h3 class='title'><a name='cupsFileGets'>cupsFileGets()</a></h3>
<h4>Description</h4>
<p>Get a CR and/or LF-terminated line.</p>
<h4>Syntax</h4>
<pre>
char *
cupsFileGets(
<a href='#cups_file_t'>cups_file_t</a> * fp,
char * buf,
size_t buflen);
</pre>
<h4>Arguments</h4>
<div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
<thead><tr><th>Name</th><th>Description</th></tr></thead>
<tbody>
<tr><td><tt>fp</tt></td><td>CUPS file</td></tr>
<tr><td><tt>buf</tt></td><td>String buffer</td></tr>
<tr><td><tt>buflen</tt></td><td>Size of string buffer</td></tr>
</tbody></table></div>
<h4>Returns</h4>
<p>Line read or NULL on eof/error</p>
<!-- NEW PAGE -->
<h3 class='title'><a name='cupsFileLock'>cupsFileLock()</a></h3>
<h4>Description</h4>
<p>Temporarily lock access to a file.</p>
<h4>Syntax</h4>
<pre>
int
cupsFileLock(
<a href='#cups_file_t'>cups_file_t</a> * fp,
int block);
</pre>
<h4>Arguments</h4>
<div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
<thead><tr><th>Name</th><th>Description</th></tr></thead>
<tbody>
<tr><td><tt>fp</tt></td><td>File to lock</td></tr>
<tr><td><tt>block</tt></td><td>1 to wait for the lock, 0 to fail right away</td></tr>
</tbody></table></div>
<h4>Returns</h4>
<p>0 on success, -1 on error</p>
<!-- NEW PAGE -->
<h3 class='title'><a name='cupsFileNumber'>cupsFileNumber()</a></h3>
<h4>Description</h4>
<p>Return the file descriptor associated with a CUPS file.</p>
<h4>Syntax</h4>
<pre>
int
cupsFileNumber(
<a href='#cups_file_t'>cups_file_t</a> * fp);
</pre>
<h4>Arguments</h4>
<div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
<thead><tr><th>Name</th><th>Description</th></tr></thead>
<tbody>
<tr><td><tt>fp</tt></td><td>CUPS file</td></tr>
</tbody></table></div>
<h4>Returns</h4>
<p>File descriptor</p>
<!-- NEW PAGE -->
<h3 class='title'><a name='cupsFileOpen'>cupsFileOpen()</a></h3>
<h4>Description</h4>
<p>Open a CUPS file.</p>
<h4>Syntax</h4>
<pre>
<a href='#cups_file_t'>cups_file_t</a> *
cupsFileOpen(
const char * filename,
const char * mode);
</pre>
<h4>Arguments</h4>
<div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
<thead><tr><th>Name</th><th>Description</th></tr></thead>
<tbody>
<tr><td><tt>filename</tt></td><td>Name of file</td></tr>
<tr><td><tt>mode</tt></td><td>Open mode</td></tr>
</tbody></table></div>
<h4>Returns</h4>
<p>CUPS file or NULL</p>
<!-- NEW PAGE -->
<h3 class='title'><a name='cupsFileOpenFd'>cupsFileOpenFd()</a></h3>
<h4>Description</h4>
<p>Open a CUPS file using a file descriptor.</p>
<h4>Syntax</h4>
<pre>
<a href='#cups_file_t'>cups_file_t</a> *
cupsFileOpenFd(
int fd,
const char * mode);
</pre>
<h4>Arguments</h4>
<div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
<thead><tr><th>Name</th><th>Description</th></tr></thead>
<tbody>
<tr><td><tt>fd</tt></td><td>File descriptor</td></tr>
<tr><td><tt>mode</tt></td><td>Open mode</td></tr>
</tbody></table></div>
<h4>Returns</h4>
<p>CUPS file or NULL</p>
<!-- NEW PAGE -->
<h3 class='title'><a name='cupsFilePeekChar'>cupsFilePeekChar()</a></h3>
<h4>Description</h4>
<p>Peek at the next character from a file.</p>
<h4>Syntax</h4>
<pre>
int
cupsFilePeekChar(
<a href='#cups_file_t'>cups_file_t</a> * fp);
</pre>
<h4>Arguments</h4>
<div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
<thead><tr><th>Name</th><th>Description</th></tr></thead>
<tbody>
<tr><td><tt>fp</tt></td><td>CUPS file</td></tr>
</tbody></table></div>
<h4>Returns</h4>
<p>Character or -1 on EOF</p>
<!-- NEW PAGE -->
<h3 class='title'><a name='cupsFilePrintf'>cupsFilePrintf()</a></h3>
<h4>Description</h4>
<p>Write a formatted string.</p>
<h4>Syntax</h4>
<pre>
int
cupsFilePrintf(
<a href='#cups_file_t'>cups_file_t</a> * fp,
const char * format,
...);
</pre>
<h4>Arguments</h4>
<div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
<thead><tr><th>Name</th><th>Description</th></tr></thead>
<tbody>
<tr><td><tt>fp</tt></td><td>CUPS file</td></tr>
<tr><td><tt>format</tt></td><td>Printf-style format string</td></tr>
<tr><td><tt>...</tt></td><td>Additional args as necessary</td></tr>
</tbody></table></div>
<h4>Returns</h4>
<p>Number of bytes written or -1</p>
<!-- NEW PAGE -->
<h3 class='title'><a name='cupsFilePutChar'>cupsFilePutChar()</a></h3>
<h4>Description</h4>
<p>Write a character.</p>
<h4>Syntax</h4>
<pre>
int
cupsFilePutChar(
<a href='#cups_file_t'>cups_file_t</a> * fp,
int c);
</pre>
<h4>Arguments</h4>
<div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
<thead><tr><th>Name</th><th>Description</th></tr></thead>
<tbody>
<tr><td><tt>fp</tt></td><td>CUPS file</td></tr>
<tr><td><tt>c</tt></td><td>Character to write</td></tr>
</tbody></table></div>
<h4>Returns</h4>
<p>0 on success, -1 on error</p>
<!-- NEW PAGE -->
<h3 class='title'><a name='cupsFilePuts'>cupsFilePuts()</a></h3>
<h4>Description</h4>
<p>Write a string.</p>
<h4>Syntax</h4>
<pre>
int
cupsFilePuts(
<a href='#cups_file_t'>cups_file_t</a> * fp,
const char * s);
</pre>
<h4>Arguments</h4>
<div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
<thead><tr><th>Name</th><th>Description</th></tr></thead>
<tbody>
<tr><td><tt>fp</tt></td><td>CUPS file</td></tr>
<tr><td><tt>s</tt></td><td>String to write</td></tr>
</tbody></table></div>
<h4>Returns</h4>
<p>Number of bytes written or -1</p>
<!-- NEW PAGE -->
<h3 class='title'><a name='cupsFileRead'>cupsFileRead()</a></h3>
<h4>Description</h4>
<p>Read from a file.</p>
<h4>Syntax</h4>
<pre>
<a href='#ssize_t'>ssize_t</a>
cupsFileRead(
<a href='#cups_file_t'>cups_file_t</a> * fp,
char * buf,
size_t bytes);
</pre>
<h4>Arguments</h4>
<div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
<thead><tr><th>Name</th><th>Description</th></tr></thead>
<tbody>
<tr><td><tt>fp</tt></td><td>CUPS file</td></tr>
<tr><td><tt>buf</tt></td><td>Buffer</td></tr>
<tr><td><tt>bytes</tt></td><td>Number of bytes to read</td></tr>
</tbody></table></div>
<h4>Returns</h4>
<p>Number of bytes read or -1</p>
<!-- NEW PAGE -->
<h3 class='title'><a name='cupsFileRewind'>cupsFileRewind()</a></h3>
<h4>Description</h4>
<p>Rewind a file.</p>
<h4>Syntax</h4>
<pre>
off_t
cupsFileRewind(
<a href='#cups_file_t'>cups_file_t</a> * fp);
</pre>
<h4>Arguments</h4>
<div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
<thead><tr><th>Name</th><th>Description</th></tr></thead>
<tbody>
<tr><td><tt>fp</tt></td><td>CUPS file</td></tr>
</tbody></table></div>
<h4>Returns</h4>
<p>New file position or -1</p>
<!-- NEW PAGE -->
<h3 class='title'><a name='cupsFileSeek'>cupsFileSeek()</a></h3>
<h4>Description</h4>
<p>Seek in a file.</p>
<h4>Syntax</h4>
<pre>
off_t
cupsFileSeek(
<a href='#cups_file_t'>cups_file_t</a> * fp,
off_t pos);
</pre>
<h4>Arguments</h4>
<div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
<thead><tr><th>Name</th><th>Description</th></tr></thead>
<tbody>
<tr><td><tt>fp</tt></td><td>CUPS file</td></tr>
<tr><td><tt>pos</tt></td><td>Position in file</td></tr>
</tbody></table></div>
<h4>Returns</h4>
<p>New file position or -1</p>
<!-- NEW PAGE -->
<h3 class='title'><a name='cupsFileStderr'>cupsFileStderr()</a></h3>
<h4>Description</h4>
<p>Just reposition the current pointer, since we have the right
range...</p>
<h4>Syntax</h4>
<pre>
<a href='#cups_file_t'>cups_file_t</a> *
cupsFileStderr(void);
</pre>
<h4>Arguments</h4>
<p>None.</p>
<h4>Returns</h4>
<p>Return a CUPS file associated with stderr.</p>
<!-- NEW PAGE -->
<h3 class='title'><a name='cupsFileStdin'>cupsFileStdin()</a></h3>
<h4>Description</h4>
<p>Open file descriptor 2...</p>
<h4>Syntax</h4>
<pre>
<a href='#cups_file_t'>cups_file_t</a> *
cupsFileStdin(void);
</pre>
<h4>Arguments</h4>
<p>None.</p>
<h4>Returns</h4>
<p>Return a CUPS file associated with stdin.</p>
<!-- NEW PAGE -->
<h3 class='title'><a name='cupsFileStdout'>cupsFileStdout()</a></h3>
<h4>Description</h4>
<p>Open file descriptor 0...</p>
<h4>Syntax</h4>
<pre>
<a href='#cups_file_t'>cups_file_t</a> *
cupsFileStdout(void);
</pre>
<h4>Arguments</h4>
<p>None.</p>
<h4>Returns</h4>
<p>Return a CUPS file associated with stdout.</p>
<!-- NEW PAGE -->
<h3 class='title'><a name='cupsFileTell'>cupsFileTell()</a></h3>
<h4>Description</h4>
<p>Return the current file position.</p>
<h4>Syntax</h4>
<pre>
off_t
cupsFileTell(
<a href='#cups_file_t'>cups_file_t</a> * fp);
</pre>
<h4>Arguments</h4>
<div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
<thead><tr><th>Name</th><th>Description</th></tr></thead>
<tbody>
<tr><td><tt>fp</tt></td><td>CUPS file</td></tr>
</tbody></table></div>
<h4>Returns</h4>
<p>File position</p>
<!-- NEW PAGE -->
<h3 class='title'><a name='cupsFileUnlock'>cupsFileUnlock()</a></h3>
<h4>Description</h4>
<p>Unlock access to a file.</p>
<h4>Syntax</h4>
<pre>
int
cupsFileUnlock(
<a href='#cups_file_t'>cups_file_t</a> * fp);
</pre>
<h4>Arguments</h4>
<div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
<thead><tr><th>Name</th><th>Description</th></tr></thead>
<tbody>
<tr><td><tt>fp</tt></td><td>File to lock</td></tr>
</tbody></table></div>
<h4>Returns</h4>
<p>0 on success, -1 on error</p>
<!-- NEW PAGE -->
<h3 class='title'><a name='cupsFileWrite'>cupsFileWrite()</a></h3>
<h4>Description</h4>
<p>Write to a file.</p>
<h4>Syntax</h4>
<pre>
<a href='#ssize_t'>ssize_t</a>
cupsFileWrite(
<a href='#cups_file_t'>cups_file_t</a> * fp,
const char * buf,
size_t bytes);
</pre>
<h4>Arguments</h4>
<div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
<thead><tr><th>Name</th><th>Description</th></tr></thead>
<tbody>
<tr><td><tt>fp</tt></td><td>CUPS file</td></tr>
<tr><td><tt>buf</tt></td><td>Buffer</td></tr>
<tr><td><tt>bytes</tt></td><td>Number of bytes to write</td></tr>
</tbody></table></div>
<h4>Returns</h4>
<p>Number of bytes written</p>
<!-- NEW PAGE -->
<h2 class='title'><a name='STRUCTURES'>Structures</a></h2>
<ul>
<li><a href='#cups_dentry_s'><tt>cups_dentry_s</tt></a> </li>
</ul>
<!-- NEW PAGE -->
<h3 class='title'><a name='cups_dentry_s'>cups_dentry_s</a></h3>
<h4>Description</h4>
<p>Directory entry type</p>
<h4>Definition</h4>
<pre>
struct cups_dentry_s
{
struct stat fileinfo;
char filename[260];
};
</pre>
<h4>Members</h4>
<div class='table'><table align='center' border='1' width='80%'>
<thead><tr><th>Name</th><th>Description</th></tr></thead>
<tbody>
<tr><td><tt>fileinfo</tt> </td><td>File information</td></tr>
<tr><td><tt>filename[260]</tt> </td><td>File name</td></tr>
</tbody></table></div>
<!-- NEW PAGE -->
<h2 class='title'><a name='TYPES'>Types</a></h2>
<ul>
<li><a href='#cups_dentry_t'><tt>cups_dentry_t</tt></a> </li>
<li><a href='#cups_dir_t'><tt>cups_dir_t</tt></a> </li>
<li><a href='#cups_file_t'><tt>cups_file_t</tt></a> </li>
</ul>
<!-- NEW PAGE -->
<h3 class='title'><a name='cups_dentry_t'>cups_dentry_t</a></h3>
<h4>Description</h4>
<p>Directory entry type</p>
<h4>Definition</h4>
<pre>
typedef struct <a href='#cups_dentry_s'>cups_dentry_s</a> cups_dentry_t;
</pre>
<!-- NEW PAGE -->
<h3 class='title'><a name='cups_dir_t'>cups_dir_t</a></h3>
<h4>Description</h4>
<p>Directory type</p>
<h4>Definition</h4>
<pre>
typedef struct _cups_dir_s cups_dir_t;
</pre>
<!-- NEW PAGE -->
<h3 class='title'><a name='cups_file_t'>cups_file_t</a></h3>
<h4>Description</h4>
<p>CUPS file type</p>
<h4>Definition</h4>
<pre>
typedef struct _cups_file_s cups_file_t;
</pre>
</body>
</html>
|
