summaryrefslogtreecommitdiff
path: root/doc/help/api-mime.html
blob: 7d759781f5fae7ca8b4a05307454066ea809ce3b (plain)
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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- SECTION: Programming -->
<head>
<title>MIME API</title>
<meta name="keywords" content="Programming">
<meta name="creator" content="Mini-XML v2.6">
<style type="text/css"><!--
BODY {
  font-family: lucida grande, geneva, helvetica, arial, sans-serif;
}

H1, H2, H3, H4, H5, H6, P, TD, TH {
  font-family: lucida grande, geneva, helvetica, arial, sans-serif;
}

KBD {
  font-family: monaco, courier, monospace;
  font-weight: bold;
}

PRE {
  font-family: monaco, courier, monospace;
}

PRE.command {
  margin-left: 36pt;
}

P.compact {
  margin: 0;
}

P.example {
  font-style: italic;
  margin-left: 36pt;
}
  
PRE.example {
  background: #eeeeee;
  border: dotted thin #999999;
  margin-left: 36pt;
  padding: 10px;
}

PRE.command EM, PRE.example EM {
  font-family: lucida grande, geneva, helvetica, arial, sans-serif;
}

P.command {
  font-family: monaco, courier, monospace;
  margin-left: 36pt;
}

P.formula {
  font-style: italic;
  margin-left: 36pt;
}

BLOCKQUOTE {
  background: #cccccc;
  border: solid thin #999999;
  padding: 10pt;
}

A IMG {
  border: none;
}

A:link:hover IMG {
  background: #f0f0f0;
  border-radius: 10px;
  -moz-border-radius: 10px;
}

A:link, A:visited {
  font-weight: normal;
  text-decoration: none;
}

A:link:hover, A:visited:hover, A:active {
  text-decoration: underline;
}

SUB, SUP {
  font-size: 50%;
}

TR.data, TD.data, TR.data TD {
  margin-top: 10pt;
  padding: 5pt;
  border-bottom: solid 1pt #999999;
}

TR.data TH {
  border-bottom: solid 1pt #999999;
  padding-top: 10pt;
  padding-left: 5pt;
  text-align: left;
}

DIV.table TABLE {
  border: solid thin #999999;
  border-collapse: collapse;
  border-spacing: 0;
  margin-left: auto;
  margin-right: auto;
}

DIV.table CAPTION {
  caption-side: top;
  font-size: 120%;
  font-style: italic;
  font-weight: bold;
  margin-left: auto;
  margin-right: auto;
}

DIV.table TABLE TD {
  border: solid thin #cccccc;
  padding-top: 5pt;
}

DIV.table TABLE TH {
  background: #cccccc;
  border: none;
  border-bottom: solid thin #999999;
}

DIV.figure TABLE {
  margin-left: auto;
  margin-right: auto;
}

DIV.figure CAPTION {
  caption-side: bottom;
  font-size: 120%;
  font-style: italic;
  font-weight: bold;
  margin-left: auto;
  margin-right: auto;
}

TH.label {
  text-align: right;
  vertical-align: top;
}

TH.sublabel {
  text-align: right;
  font-weight: normal;
}

HR {
  border: solid thin;
}

SPAN.info {
  background: black;
  border: thin solid black;
  color: white;
  font-size: 80%;
  font-style: italic;
  font-weight: bold;
  white-space: nowrap;
}

H2 SPAN.info, H3 SPAN.info, H4 SPAN.info {
  float: right;
  font-size: 100%;
}

H2.title, H3.title {
  border-bottom: solid 2pt #000000;
}

DIV.indent, TABLE.indent {
  margin-top: 2em;
  margin-left: auto;
  margin-right: auto;
  width: 90%;
}

TABLE.indent {
  border-collapse: collapse;
}

TABLE.indent TD, TABLE.indent TH {
  padding: 0;
}

TABLE.list {
  border-collapse: collapse;
  margin-left: auto;
  margin-right: auto;
  width: 90%;
}

TABLE.list TH {
  background: white;
  border-bottom: solid thin #cccccc;
  color: #444444;
  padding-top: 10pt;
  padding-left: 5pt;
  text-align: left;
  vertical-align: bottom;
  white-space: nowrap;
}

TABLE.list TH A {
  color: #4444cc;
}

TABLE.list TD {
  border-bottom: solid thin #eeeeee;
  padding-top: 5pt;
  padding-left: 5pt;
}

TABLE.list TR:nth-child(even) {
  background: #f8f8f8;
}

TABLE.list TR:nth-child(odd) {
  background: #f4f4f4;
}

DT {
  margin-left: 36pt;
  margin-top: 12pt;
}

DD {
  margin-left: 54pt;
}

DL.category DT {
  font-weight: bold;
}

P.summary {
  margin-left: 36pt;
  font-family: monaco, courier, monospace;
}

DIV.summary TABLE {
  border: solid thin #999999;
  border-collapse: collapse;
  border-spacing: 0;
  margin: 10px;
}

DIV.summary TABLE TD, DIV.summary TABLE TH {
  border: solid thin #999999;
  padding: 5px;
  text-align: left;
  vertical-align: top;
}

DIV.summary TABLE THEAD TH {
  background: #eeeeee;
}

/* API documentation styles... */
div.body h1 {
  margin: 0;
}
div.body h2 {
  margin-top: 1.5em;
}
div.body h3, div.body h4, div.body h5 {
  margin-bottom: 0.5em;
  margin-top: 1.5em;
}
.class, .enumeration, .function, .struct, .typedef, .union {
  border-bottom: solid thin #999999;
  margin-bottom: 0;
  margin-top: 2em;
}
.description {
  margin-top: 0.5em;
}
code, p.code, pre, ul.code li {
  font-family: monaco, courier, monospace;
  font-size: 90%;
}
ul.code, ul.contents, ul.subcontents {
  list-style-type: none;
  margin: 0;
  padding-left: 0;
}
ul.code li {
  margin: 0;
}
ul.contents > li {
  margin-top: 1em;
}
ul.contents li ul.code, ul.contents li ul.subcontents {
  padding-left: 2em;
}
div.body dl {
  margin-left: 0;
  margin-top: 0;
}
div.body dt {
  font-style: italic;
  margin-left: 0;
  margin-top: 0;
}
div.body dd {
  margin-bottom: 0.5em;
}

/* This is just for the HTML files generated with the framedhelp target */
div.contents {
  background: #e8e8e8;
  border: solid thin black;
  padding: 10px;
}
div.contents h1 {
  font-size: 110%;
}
div.contents h2 {
  font-size: 100%;
}
div.contents ul.contents {
  font-size: 80%;
}
div.contents ul.subcontents li {
  margin-left: 1em;
  text-indent: -1em;
}
--></style>
</head>
<body>
<div class='body'>
<h2 class="title">Contents</h2>
<ul class="contents">
<li><a href="#FUNCTIONS">Functions</a><ul class="code">
<li><a href="#mimeAddFilter" title="Add a filter to the current MIME database.">mimeAddFilter</a></li>
<li><a href="#mimeAddType" title="Add a MIME type to a database.">mimeAddType</a></li>
<li><a href="#mimeAddTypeRule" title="Add a detection rule for a file type.">mimeAddTypeRule</a></li>
<li><a href="#mimeDelete" title="Delete (free) a MIME database.">mimeDelete</a></li>
<li><a href="#mimeDeleteFilter" title="Delete a filter from the MIME database.">mimeDeleteFilter</a></li>
<li><a href="#mimeDeleteType" title="Delete a type from the MIME database.">mimeDeleteType</a></li>
<li><a href="#mimeFileType" title="Determine the type of a file.">mimeFileType</a></li>
<li><a href="#mimeFilter" title="Find the fastest way to convert from one type to another.">mimeFilter</a></li>
<li><a href="#mimeFilterLookup" title="Lookup a filter...">mimeFilterLookup</a></li>
<li><a href="#mimeFirstFilter" title="Get the first filter in the MIME database.">mimeFirstFilter</a></li>
<li><a href="#mimeFirstType" title="Get the first type in the MIME database.">mimeFirstType</a></li>
<li><a href="#mimeLoad" title="Create a new MIME database from disk.">mimeLoad</a></li>
<li><a href="#mimeLoadFilters" title="Load filter definitions from disk.">mimeLoadFilters</a></li>
<li><a href="#mimeLoadTypes" title="Load type definitions from disk.">mimeLoadTypes</a></li>
<li><a href="#mimeNextFilter" title="Get the next filter in the MIME database.">mimeNextFilter</a></li>
<li><a href="#mimeNextType" title="Get the next type in the MIME database.">mimeNextType</a></li>
<li><a href="#mimeNumFilters" title="MIME database">mimeNumFilters</a></li>
<li><a href="#mimeNumTypes" title="MIME database">mimeNumTypes</a></li>
<li><a href="#mimeType" title="Lookup a file type.">mimeType</a></li>
</ul></li>
<li><a href="#TYPES">Data Types</a><ul class="code">
	<li><a href="#mime_filter_t" title="MIME Conversion Filter Data">mime_filter_t</a></li>
	<li><a href="#mime_magic_t" title="MIME Magic Data">mime_magic_t</a></li>
	<li><a href="#mime_op_t" title="Types/structures...">mime_op_t</a></li>
	<li><a href="#mime_t" title="MIME Database">mime_t</a></li>
	<li><a href="#mime_type_t" title="MIME Type Data">mime_type_t</a></li>
</ul></li>
<h2 class="title"><a name="FUNCTIONS">Functions</a></h2>
<h3 class="function"><a name="mimeAddFilter">mimeAddFilter</a></h3>
<p class="description">Add a filter to the current MIME database.</p>
<p class="code">
<a href="#mime_filter_t">mime_filter_t</a> *mimeAddFilter (<br>
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#mime_t">mime_t</a> *mime,<br>
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#mime_type_t">mime_type_t</a> *src,<br>
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#mime_type_t">mime_type_t</a> *dst,<br>
&nbsp;&nbsp;&nbsp;&nbsp;int cost,<br>
&nbsp;&nbsp;&nbsp;&nbsp;const char *filter<br>
);</p>
<h4 class="parameters">Parameters</h4>
<dl>
<dt>mime</dt>
<dd class="description">MIME database</dd>
<dt>src</dt>
<dd class="description">Source type</dd>
<dt>dst</dt>
<dd class="description">Destination type</dd>
<dt>cost</dt>
<dd class="description">Relative time/resource cost</dd>
<dt>filter</dt>
<dd class="description">Filter program to run</dd>
</dl>
<h4 class="returnvalue">Return Value</h4>
<p class="description">New filter</p>
<h3 class="function"><a name="mimeAddType">mimeAddType</a></h3>
<p class="description">Add a MIME type to a database.</p>
<p class="code">
<a href="#mime_type_t">mime_type_t</a> *mimeAddType (<br>
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#mime_t">mime_t</a> *mime,<br>
&nbsp;&nbsp;&nbsp;&nbsp;const char *super,<br>
&nbsp;&nbsp;&nbsp;&nbsp;const char *type<br>
);</p>
<h4 class="parameters">Parameters</h4>
<dl>
<dt>mime</dt>
<dd class="description">MIME database</dd>
<dt>super</dt>
<dd class="description">Super-type name</dd>
<dt>type</dt>
<dd class="description">Type name</dd>
</dl>
<h4 class="returnvalue">Return Value</h4>
<p class="description">New (or existing) MIME type</p>
<h3 class="function"><a name="mimeAddTypeRule">mimeAddTypeRule</a></h3>
<p class="description">Add a detection rule for a file type.</p>
<p class="code">
int mimeAddTypeRule (<br>
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#mime_type_t">mime_type_t</a> *mt,<br>
&nbsp;&nbsp;&nbsp;&nbsp;const char *rule<br>
);</p>
<h4 class="parameters">Parameters</h4>
<dl>
<dt>mt</dt>
<dd class="description">Type to add to</dd>
<dt>rule</dt>
<dd class="description">Rule to add</dd>
</dl>
<h4 class="returnvalue">Return Value</h4>
<p class="description">0 on success, -1 on failure</p>
<h3 class="function"><a name="mimeDelete">mimeDelete</a></h3>
<p class="description">Delete (free) a MIME database.</p>
<p class="code">
void mimeDelete (<br>
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#mime_t">mime_t</a> *mime<br>
);</p>
<h4 class="parameters">Parameters</h4>
<dl>
<dt>mime</dt>
<dd class="description">MIME database</dd>
</dl>
<h3 class="function"><a name="mimeDeleteFilter">mimeDeleteFilter</a></h3>
<p class="description">Delete a filter from the MIME database.</p>
<p class="code">
void mimeDeleteFilter (<br>
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#mime_t">mime_t</a> *mime,<br>
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#mime_filter_t">mime_filter_t</a> *filter<br>
);</p>
<h4 class="parameters">Parameters</h4>
<dl>
<dt>mime</dt>
<dd class="description">MIME database</dd>
<dt>filter</dt>
<dd class="description">Filter</dd>
</dl>
<h3 class="function"><a name="mimeDeleteType">mimeDeleteType</a></h3>
<p class="description">Delete a type from the MIME database.</p>
<p class="code">
void mimeDeleteType (<br>
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#mime_t">mime_t</a> *mime,<br>
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#mime_type_t">mime_type_t</a> *mt<br>
);</p>
<h4 class="parameters">Parameters</h4>
<dl>
<dt>mime</dt>
<dd class="description">MIME database</dd>
<dt>mt</dt>
<dd class="description">Type</dd>
</dl>
<h3 class="function"><a name="mimeFileType">mimeFileType</a></h3>
<p class="description">Determine the type of a file.</p>
<p class="code">
<a href="#mime_type_t">mime_type_t</a> *mimeFileType (<br>
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#mime_t">mime_t</a> *mime,<br>
&nbsp;&nbsp;&nbsp;&nbsp;const char *pathname,<br>
&nbsp;&nbsp;&nbsp;&nbsp;const char *filename,<br>
&nbsp;&nbsp;&nbsp;&nbsp;int *compression<br>
);</p>
<h4 class="parameters">Parameters</h4>
<dl>
<dt>mime</dt>
<dd class="description">MIME database</dd>
<dt>pathname</dt>
<dd class="description">Name of file to check on disk</dd>
<dt>filename</dt>
<dd class="description">Original filename or NULL</dd>
<dt>compression</dt>
<dd class="description">Is the file compressed?</dd>
</dl>
<h4 class="returnvalue">Return Value</h4>
<p class="description">Type of file</p>
<h3 class="function"><a name="mimeFilter">mimeFilter</a></h3>
<p class="description">Find the fastest way to convert from one type to another.</p>
<p class="code">
cups_array_t *mimeFilter (<br>
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#mime_t">mime_t</a> *mime,<br>
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#mime_type_t">mime_type_t</a> *src,<br>
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#mime_type_t">mime_type_t</a> *dst,<br>
&nbsp;&nbsp;&nbsp;&nbsp;int *cost<br>
);</p>
<h4 class="parameters">Parameters</h4>
<dl>
<dt>mime</dt>
<dd class="description">MIME database</dd>
<dt>src</dt>
<dd class="description">Source file type</dd>
<dt>dst</dt>
<dd class="description">Destination file type</dd>
<dt>cost</dt>
<dd class="description">Cost of filters</dd>
</dl>
<h4 class="returnvalue">Return Value</h4>
<p class="description">Array of filters to run</p>
<h3 class="function"><a name="mimeFilterLookup">mimeFilterLookup</a></h3>
<p class="description">Lookup a filter...</p>
<p class="code">
<a href="#mime_filter_t">mime_filter_t</a> *mimeFilterLookup (<br>
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#mime_t">mime_t</a> *mime,<br>
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#mime_type_t">mime_type_t</a> *src,<br>
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#mime_type_t">mime_type_t</a> *dst<br>
);</p>
<h4 class="parameters">Parameters</h4>
<dl>
<dt>mime</dt>
<dd class="description">MIME database</dd>
<dt>src</dt>
<dd class="description">Source type</dd>
<dt>dst</dt>
<dd class="description">Destination type</dd>
</dl>
<h4 class="returnvalue">Return Value</h4>
<p class="description">Filter for src-&gt;dst</p>
<h3 class="function"><a name="mimeFirstFilter">mimeFirstFilter</a></h3>
<p class="description">Get the first filter in the MIME database.</p>
<p class="code">
<a href="#mime_filter_t">mime_filter_t</a> *mimeFirstFilter (<br>
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#mime_t">mime_t</a> *mime<br>
);</p>
<h4 class="parameters">Parameters</h4>
<dl>
<dt>mime</dt>
<dd class="description">MIME database</dd>
</dl>
<h4 class="returnvalue">Return Value</h4>
<p class="description">Filter or NULL</p>
<h3 class="function"><a name="mimeFirstType">mimeFirstType</a></h3>
<p class="description">Get the first type in the MIME database.</p>
<p class="code">
<a href="#mime_type_t">mime_type_t</a> *mimeFirstType (<br>
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#mime_t">mime_t</a> *mime<br>
);</p>
<h4 class="parameters">Parameters</h4>
<dl>
<dt>mime</dt>
<dd class="description">MIME database</dd>
</dl>
<h4 class="returnvalue">Return Value</h4>
<p class="description">Type or NULL</p>
<h3 class="function"><a name="mimeLoad">mimeLoad</a></h3>
<p class="description">Create a new MIME database from disk.</p>
<p class="code">
<a href="#mime_t">mime_t</a> *mimeLoad (<br>
&nbsp;&nbsp;&nbsp;&nbsp;const char *pathname,<br>
&nbsp;&nbsp;&nbsp;&nbsp;const char *filterpath<br>
);</p>
<h4 class="parameters">Parameters</h4>
<dl>
<dt>pathname</dt>
<dd class="description">Directory to load</dd>
<dt>filterpath</dt>
<dd class="description">Directory to load</dd>
</dl>
<h4 class="returnvalue">Return Value</h4>
<p class="description">New MIME database</p>
<h4 class="discussion">Discussion</h4>
<p class="discussion">This function uses <a href="#mimeLoadFilters"><code>mimeLoadFilters</code></a> and <a href="#mimeLoadTypes"><code>mimeLoadTypes</code></a> to
create a MIME database from a single directory.</p>
<h3 class="function"><a name="mimeLoadFilters">mimeLoadFilters</a></h3>
<p class="description">Load filter definitions from disk.</p>
<p class="code">
<a href="#mime_t">mime_t</a> *mimeLoadFilters (<br>
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#mime_t">mime_t</a> *mime,<br>
&nbsp;&nbsp;&nbsp;&nbsp;const char *pathname,<br>
&nbsp;&nbsp;&nbsp;&nbsp;const char *filterpath<br>
);</p>
<h4 class="parameters">Parameters</h4>
<dl>
<dt>mime</dt>
<dd class="description">MIME database</dd>
<dt>pathname</dt>
<dd class="description">Directory to load from</dd>
<dt>filterpath</dt>
<dd class="description">Default filter program directory</dd>
</dl>
<h4 class="returnvalue">Return Value</h4>
<p class="description">MIME database</p>
<h4 class="discussion">Discussion</h4>
<p class="discussion">This function loads all of the .convs files from the specified directory.
Use <a href="#mimeLoadTypes"><code>mimeLoadTypes</code></a> to load all types before you load the filters.</p>
<h3 class="function"><a name="mimeLoadTypes">mimeLoadTypes</a></h3>
<p class="description">Load type definitions from disk.</p>
<p class="code">
<a href="#mime_t">mime_t</a> *mimeLoadTypes (<br>
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#mime_t">mime_t</a> *mime,<br>
&nbsp;&nbsp;&nbsp;&nbsp;const char *pathname<br>
);</p>
<h4 class="parameters">Parameters</h4>
<dl>
<dt>mime</dt>
<dd class="description">MIME database or <code>NULL</code> to create a new one</dd>
<dt>pathname</dt>
<dd class="description">Directory to load from</dd>
</dl>
<h4 class="returnvalue">Return Value</h4>
<p class="description">MIME database</p>
<h4 class="discussion">Discussion</h4>
<p class="discussion">This function loads all of the .types files from the specified directory.
Use <a href="#mimeLoadFilters"><code>mimeLoadFilters</code></a> to load all filters after you load the types.</p>
<h3 class="function"><a name="mimeNextFilter">mimeNextFilter</a></h3>
<p class="description">Get the next filter in the MIME database.</p>
<p class="code">
<a href="#mime_filter_t">mime_filter_t</a> *mimeNextFilter (<br>
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#mime_t">mime_t</a> *mime<br>
);</p>
<h4 class="parameters">Parameters</h4>
<dl>
<dt>mime</dt>
<dd class="description">MIME database</dd>
</dl>
<h4 class="returnvalue">Return Value</h4>
<p class="description">Filter or NULL</p>
<h3 class="function"><a name="mimeNextType">mimeNextType</a></h3>
<p class="description">Get the next type in the MIME database.</p>
<p class="code">
<a href="#mime_type_t">mime_type_t</a> *mimeNextType (<br>
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#mime_t">mime_t</a> *mime<br>
);</p>
<h4 class="parameters">Parameters</h4>
<dl>
<dt>mime</dt>
<dd class="description">MIME database</dd>
</dl>
<h4 class="returnvalue">Return Value</h4>
<p class="description">Type or NULL</p>
<h3 class="function"><a name="mimeNumFilters">mimeNumFilters</a></h3>
<p class="description">MIME database</p>
<p class="code">
int mimeNumFilters (<br>
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#mime_t">mime_t</a> *mime<br>
);</p>
<h4 class="parameters">Parameters</h4>
<dl>
<dt>mime</dt>
<dd class="description">MIME database</dd>
</dl>
<h4 class="returnvalue">Return Value</h4>
<p class="description">Get the number of filters in a MIME database.</p>
<h3 class="function"><a name="mimeNumTypes">mimeNumTypes</a></h3>
<p class="description">MIME database</p>
<p class="code">
int mimeNumTypes (<br>
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#mime_t">mime_t</a> *mime<br>
);</p>
<h4 class="parameters">Parameters</h4>
<dl>
<dt>mime</dt>
<dd class="description">MIME database</dd>
</dl>
<h4 class="returnvalue">Return Value</h4>
<p class="description">Get the number of types in a MIME database.</p>
<h3 class="function"><a name="mimeType">mimeType</a></h3>
<p class="description">Lookup a file type.</p>
<p class="code">
<a href="#mime_type_t">mime_type_t</a> *mimeType (<br>
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#mime_t">mime_t</a> *mime,<br>
&nbsp;&nbsp;&nbsp;&nbsp;const char *super,<br>
&nbsp;&nbsp;&nbsp;&nbsp;const char *type<br>
);</p>
<h4 class="parameters">Parameters</h4>
<dl>
<dt>mime</dt>
<dd class="description">MIME database</dd>
<dt>super</dt>
<dd class="description">Super-type name</dd>
<dt>type</dt>
<dd class="description">Type name</dd>
</dl>
<h4 class="returnvalue">Return Value</h4>
<p class="description">Matching file type definition</p>
<h2 class="title"><a name="TYPES">Data Types</a></h2>
<h3 class="typedef"><a name="mime_filter_t">mime_filter_t</a></h3>
<p class="description">MIME Conversion Filter Data</p>
<p class="code">
typedef struct _mime_filter_s mime_filter_t;
</p>
<h3 class="typedef"><a name="mime_magic_t">mime_magic_t</a></h3>
<p class="description">MIME Magic Data</p>
<p class="code">
typedef struct _mime_magic_s mime_magic_t;
</p>
<h3 class="typedef"><a name="mime_op_t">mime_op_t</a></h3>
<p class="description">Types/structures...</p>
<p class="code">
typedef enum mime_op_t;
</p>
<h3 class="typedef"><a name="mime_t">mime_t</a></h3>
<p class="description">MIME Database</p>
<p class="code">
typedef struct _mime_s mime_t;
</p>
<h3 class="typedef"><a name="mime_type_t">mime_type_t</a></h3>
<p class="description">MIME Type Data</p>
<p class="code">
typedef struct _mime_type_s mime_type_t;
</p>
</div>
</body>
</html>