Add C-docs to webpage
[lms] / www / api / lightmediascanner__utils_8c.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3 <title>Light Media Scanner: src/lib/lightmediascanner_utils.c File Reference</title>
4 <link href="doxygen.css" rel="stylesheet" type="text/css">
5 <link href="tabs.css" rel="stylesheet" type="text/css">
6 </head><body>
7 <!-- Generated by Doxygen 1.5.2 -->
8 <div class="tabs">
9   <ul>
10     <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
11     <li><a href="modules.html"><span>Modules</span></a></li>
12     <li><a href="classes.html"><span>Data&nbsp;Structures</span></a></li>
13     <li class="current"><a href="files.html"><span>Files</span></a></li>
14   </ul>
15 </div>
16 <div class="tabs">
17   <ul>
18     <li><a href="files.html"><span>File&nbsp;List</span></a></li>
19     <li><a href="globals.html"><span>Globals</span></a></li>
20   </ul>
21 </div>
22 <h1>src/lib/lightmediascanner_utils.c File Reference</h1><code>#include &lt;<a class="el" href="lightmediascanner__utils_8h-source.html">lightmediascanner_utils.h</a>&gt;</code><br>
23 <code>#include &lt;ctype.h&gt;</code><br>
24 <code>#include &lt;alloca.h&gt;</code><br>
25
26 <p>
27 Include dependency graph for lightmediascanner_utils.c:<p><center><img src="lightmediascanner__utils_8c__incl.png" border="0" usemap="#src/lib/lightmediascanner_utils.c_map" alt=""></center>
28 <map name="src/lib/lightmediascanner_utils.c_map">
29 <area shape="rect" href="lightmediascanner__utils_8h.html" title="lightmediascanner_utils.h" alt="" coords="249,5,407,32"></map>
30
31 <p>
32 <a href="lightmediascanner__utils_8c-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
33 <tr><td></td></tr>
34 <tr><td colspan="2"><br><h2>Functions</h2></td></tr>
35 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="lightmediascanner__utils_8c.html#086d2449129976541c66a83984bffbe6">lms_strstrip</a> (char *str, unsigned int *p_len)</td></tr>
36
37 <tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="lightmediascanner__utils_8c.html#71ee8b57cf7c5eba8ec0593e756d2529">lms_which_extension</a> (const char *name, unsigned int name_len, const struct <a class="el" href="structlms__string__size.html">lms_string_size</a> *exts, unsigned int exts_len)</td></tr>
38
39 </table>
40 <hr><h2>Function Documentation</h2>
41 <a class="anchor" name="086d2449129976541c66a83984bffbe6"></a><!-- doxytag: member="lightmediascanner_utils.c::lms_strstrip" ref="086d2449129976541c66a83984bffbe6" args="(char *str, unsigned int *p_len)" -->
42 <div class="memitem">
43 <div class="memproto">
44       <table class="memname">
45         <tr>
46           <td class="memname">void lms_strstrip           </td>
47           <td>(</td>
48           <td class="paramtype">char *&nbsp;</td>
49           <td class="paramname"> <em>str</em>, </td>
50         </tr>
51         <tr>
52           <td class="paramkey"></td>
53           <td></td>
54           <td class="paramtype">unsigned int *&nbsp;</td>
55           <td class="paramname"> <em>p_len</em></td><td>&nbsp;</td>
56         </tr>
57         <tr>
58           <td></td>
59           <td>)</td>
60           <td></td><td></td><td width="100%"></td>
61         </tr>
62       </table>
63 </div>
64 <div class="memdoc">
65
66 <p>
67 Strips string, in place.<p>
68 <dl compact><dt><b>Parameters:</b></dt><dd>
69   <table border="0" cellspacing="2" cellpadding="0">
70     <tr><td valign="top"></td><td valign="top"><em>str</em>&nbsp;</td><td>string to be stripped. </td></tr>
71     <tr><td valign="top"></td><td valign="top"><em>p_len</em>&nbsp;</td><td>string length to analyse, also the place where the final size is stored. </td></tr>
72   </table>
73 </dl>
74
75 <p>
76 Definition at line <a class="el" href="lightmediascanner__utils_8c-source.html#l00013">13</a> of file <a class="el" href="lightmediascanner__utils_8c-source.html">lightmediascanner_utils.c</a>.
77 </div>
78 </div><p>
79 <a class="anchor" name="71ee8b57cf7c5eba8ec0593e756d2529"></a><!-- doxytag: member="lightmediascanner_utils.c::lms_which_extension" ref="71ee8b57cf7c5eba8ec0593e756d2529" args="(const char *name, unsigned int name_len, const struct lms_string_size *exts, unsigned int exts_len)" -->
80 <div class="memitem">
81 <div class="memproto">
82       <table class="memname">
83         <tr>
84           <td class="memname">int lms_which_extension           </td>
85           <td>(</td>
86           <td class="paramtype">const char *&nbsp;</td>
87           <td class="paramname"> <em>name</em>, </td>
88         </tr>
89         <tr>
90           <td class="paramkey"></td>
91           <td></td>
92           <td class="paramtype">unsigned int&nbsp;</td>
93           <td class="paramname"> <em>name_len</em>, </td>
94         </tr>
95         <tr>
96           <td class="paramkey"></td>
97           <td></td>
98           <td class="paramtype">const struct <a class="el" href="structlms__string__size.html">lms_string_size</a> *&nbsp;</td>
99           <td class="paramname"> <em>exts</em>, </td>
100         </tr>
101         <tr>
102           <td class="paramkey"></td>
103           <td></td>
104           <td class="paramtype">unsigned int&nbsp;</td>
105           <td class="paramname"> <em>exts_len</em></td><td>&nbsp;</td>
106         </tr>
107         <tr>
108           <td></td>
109           <td>)</td>
110           <td></td><td></td><td width="100%"></td>
111         </tr>
112       </table>
113 </div>
114 <div class="memdoc">
115
116 <p>
117 Find out which of the given extensions matches the given name.<p>
118 <dl compact><dt><b>Parameters:</b></dt><dd>
119   <table border="0" cellspacing="2" cellpadding="0">
120     <tr><td valign="top"></td><td valign="top"><em>name</em>&nbsp;</td><td>string to analyse. </td></tr>
121     <tr><td valign="top"></td><td valign="top"><em>name_len</em>&nbsp;</td><td>string length. </td></tr>
122     <tr><td valign="top"></td><td valign="top"><em>exts</em>&nbsp;</td><td>array of extensions to be checked. </td></tr>
123     <tr><td valign="top"></td><td valign="top"><em>exts_len</em>&nbsp;</td><td>number of items in array <code>exts</code> </td></tr>
124   </table>
125 </dl>
126 <dl class="return" compact><dt><b>Returns:</b></dt><dd>index in <code>exts</code> or -1 if it doesn't match none. </dd></dl>
127
128 <p>
129 Definition at line <a class="el" href="lightmediascanner__utils_8c-source.html#l00069">69</a> of file <a class="el" href="lightmediascanner__utils_8c-source.html">lightmediascanner_utils.c</a>.
130 <p>
131 References <a class="el" href="lightmediascanner__utils_8h-source.html#l00050">lms_string_size::str</a>.
132 </div>
133 </div><p>
134 <hr size="1"><address style="text-align: right;"><small>Generated on Thu Dec 13 02:04:05 2007 for Light Media Scanner by&nbsp;
135 <a href="http://www.doxygen.org/index.html">
136 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.2 </small></address>
137 </body>
138 </html>