summaryrefslogtreecommitdiffstats
path: root/doc/html/group__string__list.html
blob: f6b3402165a5403db27005779d920fafc3b069e6 (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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>C-Layman: StringList</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.8 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>StringList</h1>String list management class.  
<a href="#_details">More...</a>
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Data Structures</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_string_list.html">StringList</a></td></tr>

<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="struct_string_list.html">StringList</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__string__list.html#gafedcfd6148313464f9aab9c08f87989">stringListCreate</a> (size_t len)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__string__list.html#g28cd2d1037d735a5ac3275897b0c2065">stringListInsertAt</a> (<a class="el" href="struct_string_list.html">StringList</a> *l, unsigned int pos, char *str)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__string__list.html#g307b9dca62828cbfe5c163d327f01806">stringListCount</a> (<a class="el" href="struct_string_list.html">StringList</a> *l)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__string__list.html#g43bc91c5da9f06e7c972c8f04b3a99c2">stringListGetAt</a> (<a class="el" href="struct_string_list.html">StringList</a> *l, unsigned int pos)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__string__list.html#g3ed6624cf1e5f944068f803964be6c95">stringListPrint</a> (<a class="el" href="struct_string_list.html">StringList</a> *list)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__string__list.html#ged41020feb3f2b869647cc280b493cb3">stringListFree</a> (<a class="el" href="struct_string_list.html">StringList</a> *list)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="struct_string_list.html">StringList</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__string__list.html#g52128fb831cc1a4643950bbc2ec31391">listToCList</a> (PyObject *list)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">PyObject *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__string__list.html#g2433a3f25f9fd7950892807717b8e0bd">cListToPyList</a> (<a class="el" href="struct_string_list.html">StringList</a> *list)</td></tr>

</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
String list management class. <hr><h2>Function Documentation</h2>
<a class="anchor" name="g2433a3f25f9fd7950892807717b8e0bd"></a><!-- doxytag: member="stringlist.c::cListToPyList" ref="g2433a3f25f9fd7950892807717b8e0bd" args="(StringList *list)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">PyObject* cListToPyList           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_string_list.html">StringList</a> *&nbsp;</td>
          <td class="paramname"> <em>list</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Converts a C String list to a Python List object 
</div>
</div><p>
<a class="anchor" name="g52128fb831cc1a4643950bbc2ec31391"></a><!-- doxytag: member="stringlist.c::listToCList" ref="g52128fb831cc1a4643950bbc2ec31391" args="(PyObject *list)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_string_list.html">StringList</a>* listToCList           </td>
          <td>(</td>
          <td class="paramtype">PyObject *&nbsp;</td>
          <td class="paramname"> <em>list</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
<h2><a class="anchor" name="internal">
internal</a></h2>
Converts a Python list object to a C String list 
</div>
</div><p>
<a class="anchor" name="g307b9dca62828cbfe5c163d327f01806"></a><!-- doxytag: member="stringlist.c::stringListCount" ref="g307b9dca62828cbfe5c163d327f01806" args="(StringList *l)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">unsigned int stringListCount           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_string_list.html">StringList</a> *&nbsp;</td>
          <td class="paramname"> <em>l</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get the number of strings in the list.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the number of strings in the list </dd></dl>

</div>
</div><p>
<a class="anchor" name="gafedcfd6148313464f9aab9c08f87989"></a><!-- doxytag: member="stringlist.c::stringListCreate" ref="gafedcfd6148313464f9aab9c08f87989" args="(size_t len)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_string_list.html">StringList</a>* stringListCreate           </td>
          <td>(</td>
          <td class="paramtype">size_t&nbsp;</td>
          <td class="paramname"> <em>len</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Creates a String list to use with the library. <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>len</em>&nbsp;</td><td>the number of strings in the list. </td></tr>
  </table>
</dl>

</div>
</div><p>
<a class="anchor" name="ged41020feb3f2b869647cc280b493cb3"></a><!-- doxytag: member="stringlist.c::stringListFree" ref="ged41020feb3f2b869647cc280b493cb3" args="(StringList *list)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void stringListFree           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_string_list.html">StringList</a> *&nbsp;</td>
          <td class="paramname"> <em>list</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Frees a string list and it's data 
</div>
</div><p>
<a class="anchor" name="g43bc91c5da9f06e7c972c8f04b3a99c2"></a><!-- doxytag: member="stringlist.c::stringListGetAt" ref="g43bc91c5da9f06e7c972c8f04b3a99c2" args="(StringList *l, unsigned int pos)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">char* stringListGetAt           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_string_list.html">StringList</a> *&nbsp;</td>
          <td class="paramname"> <em>l</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned int&nbsp;</td>
          <td class="paramname"> <em>pos</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get the String at position pos <dl class="return" compact><dt><b>Returns:</b></dt><dd>the String at position pos </dd></dl>

</div>
</div><p>
<a class="anchor" name="g28cd2d1037d735a5ac3275897b0c2065"></a><!-- doxytag: member="stringlist.c::stringListInsertAt" ref="g28cd2d1037d735a5ac3275897b0c2065" args="(StringList *l, unsigned int pos, char *str)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int stringListInsertAt           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_string_list.html">StringList</a> *&nbsp;</td>
          <td class="paramname"> <em>l</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned int&nbsp;</td>
          <td class="paramname"> <em>pos</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&nbsp;</td>
          <td class="paramname"> <em>str</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Inserts the string str in the list l at position pos. <dl class="return" compact><dt><b>Returns:</b></dt><dd>True if it succeeded, False if not. </dd></dl>

</div>
</div><p>
<a class="anchor" name="g3ed6624cf1e5f944068f803964be6c95"></a><!-- doxytag: member="stringlist.c::stringListPrint" ref="g3ed6624cf1e5f944068f803964be6c95" args="(StringList *list)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void stringListPrint           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_string_list.html">StringList</a> *&nbsp;</td>
          <td class="paramname"> <em>list</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Prints a C String list. 
</div>
</div><p>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Aug 6 20:00:53 2010 for C-Layman by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
</body>
</html>