File: flickcurl-section-person.html

package info (click to toggle)
flickcurl 1.26-9
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 6,784 kB
  • sloc: ansic: 26,045; sh: 11,915; xml: 1,025; makefile: 343
file content (297 lines) | stat: -rw-r--r-- 13,216 bytes parent folder | download | duplicates (6)
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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Person class.</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Flickcurl Flickr API Manual">
<link rel="up" href="index.html" title="Flickcurl Flickr API Manual">
<link rel="prev" href="flickcurl-section-people.html" title="People">
<link rel="next" href="flickcurl-section-photo.html" title="Photo">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="flickcurl-section-people.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td> </td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Flickcurl Flickr API Manual</th>
<td><a accesskey="n" href="flickcurl-section-photo.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#flickcurl-section-person.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#flickcurl-section-person.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="flickcurl-section-person"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="flickcurl-section-person.top_of_page"></a>Person class.</span></h2>
<p>Person class. — Person class.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="flickcurl-section-person.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"><span class="returnvalue">void</span>                <a class="link" href="flickcurl-section-person.html#flickcurl-free-person" title="flickcurl_free_person ()">flickcurl_free_person</a>               (<em class="parameter"><code><a class="link" href="flickcurl-section-person.html#flickcurl-person" title="flickcurl_person"><span class="type">flickcurl_person</span></a> *person</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="flickcurl-section-person.html#flickcurl-free-persons" title="flickcurl_free_persons ()">flickcurl_free_persons</a>              (<em class="parameter"><code><a class="link" href="flickcurl-section-person.html#flickcurl-person" title="flickcurl_person"><span class="type">flickcurl_person</span></a> **persons</code></em>);
const <span class="returnvalue">char</span> *        <a class="link" href="flickcurl-section-person.html#flickcurl-get-person-field-label" title="flickcurl_get_person_field_label ()">flickcurl_get_person_field_label</a>    (<em class="parameter"><code><a class="link" href="flickcurl-section-person.html#flickcurl-person-field-type" title="enum flickcurl_person_field_type"><span class="type">flickcurl_person_field_type</span></a> field</code></em>);
                    <a class="link" href="flickcurl-section-person.html#flickcurl-person" title="flickcurl_person">flickcurl_person</a>;
                    <a class="link" href="flickcurl-section-person.html#flickcurl-person-field" title="flickcurl_person_field">flickcurl_person_field</a>;
enum                <a class="link" href="flickcurl-section-person.html#flickcurl-person-field-type" title="enum flickcurl_person_field_type">flickcurl_person_field_type</a>;
</pre>
</div>
<div class="refsect1">
<a name="flickcurl-section-person.description"></a><h2>Description</h2>
<p>
Person class.
</p>
</div>
<div class="refsect1">
<a name="flickcurl-section-person.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="flickcurl-free-person"></a><h3>flickcurl_free_person ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                flickcurl_free_person               (<em class="parameter"><code><a class="link" href="flickcurl-section-person.html#flickcurl-person" title="flickcurl_person"><span class="type">flickcurl_person</span></a> *person</code></em>);</pre>
<p>
Destructor for person object
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>person</code></em> :</span></p></td>
<td>person object</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="flickcurl-free-persons"></a><h3>flickcurl_free_persons ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                flickcurl_free_persons              (<em class="parameter"><code><a class="link" href="flickcurl-section-person.html#flickcurl-person" title="flickcurl_person"><span class="type">flickcurl_person</span></a> **persons</code></em>);</pre>
<p>
Destructor for array of person object
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>persons</code></em> :</span></p></td>
<td>person object array</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="flickcurl-get-person-field-label"></a><h3>flickcurl_get_person_field_label ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> *        flickcurl_get_person_field_label    (<em class="parameter"><code><a class="link" href="flickcurl-section-person.html#flickcurl-person-field-type" title="enum flickcurl_person_field_type"><span class="type">flickcurl_person_field_type</span></a> field</code></em>);</pre>
<p>
Get label for person field
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>field</code></em> :</span></p></td>
<td>field enum</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>label string or NULL if none valid</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="flickcurl-person"></a><h3>flickcurl_person</h3>
<pre class="programlisting">typedef struct {
  char *nsid;

  flickcurl_person_field fields[PERSON_FIELD_LAST + 1];
} flickcurl_person;
</pre>
<p>
A user.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><span class="type">char</span> *<em class="structfield"><code><a name="flickcurl-person.nsid"></a>nsid</code></em>;</span></p></td>
<td>user NSID</td>
</tr>
<tr>
<td><p><span class="term"><a class="link" href="flickcurl-section-person.html#flickcurl-person-field" title="flickcurl_person_field"><span class="type">flickcurl_person_field</span></a> <em class="structfield"><code><a name="flickcurl-person.fields"></a>fields</code></em>[PERSON_FIELD_LAST + 1];</span></p></td>
<td>person fields</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="flickcurl-person-field"></a><h3>flickcurl_person_field</h3>
<pre class="programlisting">typedef struct {
  char* string;
  flickcurl_person_field_type integer;
  flickcurl_field_value_type type;
} flickcurl_person_field;
</pre>
<p>
Field of a person structure
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><span class="type">char</span> *<em class="structfield"><code><a name="flickcurl-person-field.string"></a>string</code></em>;</span></p></td>
<td>string field value</td>
</tr>
<tr>
<td><p><span class="term"><a class="link" href="flickcurl-section-person.html#flickcurl-person-field-type" title="enum flickcurl_person_field_type"><span class="type">flickcurl_person_field_type</span></a> <em class="structfield"><code><a name="flickcurl-person-field.integer"></a>integer</code></em>;</span></p></td>
<td>integer field value</td>
</tr>
<tr>
<td><p><span class="term"><a class="link" href="flickcurl-section-photo.html#flickcurl-field-value-type" title="enum flickcurl_field_value_type"><span class="type">flickcurl_field_value_type</span></a> <em class="structfield"><code><a name="flickcurl-person-field.type"></a>type</code></em>;</span></p></td>
<td>field type</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="flickcurl-person-field-type"></a><h3>enum flickcurl_person_field_type</h3>
<pre class="programlisting">typedef enum {
  PERSON_FIELD_none,
  PERSON_FIELD_isadmin,               /* boolean */
  PERSON_FIELD_ispro,                 /* boolean */
  PERSON_FIELD_iconserver,            /* integer */
  PERSON_FIELD_iconfarm,              /* integer - not in API docs */
  PERSON_FIELD_username,              /* string */
  PERSON_FIELD_realname,              /* string */
  PERSON_FIELD_mbox_sha1sum,          /* string */
  PERSON_FIELD_location,              /* string */
  PERSON_FIELD_photosurl,             /* string */
  PERSON_FIELD_profileurl,            /* string */
  PERSON_FIELD_mobileurl,             /* string - not in API docs */
  PERSON_FIELD_photos_firstdate,      /* dateTime */
  PERSON_FIELD_photos_firstdatetaken, /* dateTime */
  PERSON_FIELD_photos_count,          /* integer */
  PERSON_FIELD_photos_views,          /* integer - not in API docs */
  PERSON_FIELD_favedate,              /* dateTime - flickr.photos.getFavorites() */
  PERSON_FIELD_FIRST = PERSON_FIELD_isadmin,
  PERSON_FIELD_LAST = PERSON_FIELD_favedate
} flickcurl_person_field_type;
</pre>
<p>
Fields of a flickcurl_person*
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="PERSON-FIELD-none"></a><span class="term"><code class="literal">PERSON_FIELD_none</code></span></p></td>
<td>internal
</td>
</tr>
<tr>
<td><p><a name="PERSON-FIELD-isadmin"></a><span class="term"><code class="literal">PERSON_FIELD_isadmin</code></span></p></td>
<td>is admin field boolean
</td>
</tr>
<tr>
<td><p><a name="PERSON-FIELD-ispro"></a><span class="term"><code class="literal">PERSON_FIELD_ispro</code></span></p></td>
<td>is pro field boolean
</td>
</tr>
<tr>
<td><p><a name="PERSON-FIELD-iconserver"></a><span class="term"><code class="literal">PERSON_FIELD_iconserver</code></span></p></td>
<td>icon server integer
</td>
</tr>
<tr>
<td><p><a name="PERSON-FIELD-iconfarm"></a><span class="term"><code class="literal">PERSON_FIELD_iconfarm</code></span></p></td>
<td>icon farm integer
</td>
</tr>
<tr>
<td><p><a name="PERSON-FIELD-username"></a><span class="term"><code class="literal">PERSON_FIELD_username</code></span></p></td>
<td>username
</td>
</tr>
<tr>
<td><p><a name="PERSON-FIELD-realname"></a><span class="term"><code class="literal">PERSON_FIELD_realname</code></span></p></td>
<td>real name
</td>
</tr>
<tr>
<td><p><a name="PERSON-FIELD-mbox-sha1sum"></a><span class="term"><code class="literal">PERSON_FIELD_mbox_sha1sum</code></span></p></td>
<td>Email SHA1 sum
</td>
</tr>
<tr>
<td><p><a name="PERSON-FIELD-location"></a><span class="term"><code class="literal">PERSON_FIELD_location</code></span></p></td>
<td>location
</td>
</tr>
<tr>
<td><p><a name="PERSON-FIELD-photosurl"></a><span class="term"><code class="literal">PERSON_FIELD_photosurl</code></span></p></td>
<td>photos URL
</td>
</tr>
<tr>
<td><p><a name="PERSON-FIELD-profileurl"></a><span class="term"><code class="literal">PERSON_FIELD_profileurl</code></span></p></td>
<td>profile URL
</td>
</tr>
<tr>
<td><p><a name="PERSON-FIELD-mobileurl"></a><span class="term"><code class="literal">PERSON_FIELD_mobileurl</code></span></p></td>
<td>mobile URL
</td>
</tr>
<tr>
<td><p><a name="PERSON-FIELD-photos-firstdate"></a><span class="term"><code class="literal">PERSON_FIELD_photos_firstdate</code></span></p></td>
<td>photos first date
</td>
</tr>
<tr>
<td><p><a name="PERSON-FIELD-photos-firstdatetaken"></a><span class="term"><code class="literal">PERSON_FIELD_photos_firstdatetaken</code></span></p></td>
<td>photos first date taken
</td>
</tr>
<tr>
<td><p><a name="PERSON-FIELD-photos-count"></a><span class="term"><code class="literal">PERSON_FIELD_photos_count</code></span></p></td>
<td>photos count
</td>
</tr>
<tr>
<td><p><a name="PERSON-FIELD-photos-views"></a><span class="term"><code class="literal">PERSON_FIELD_photos_views</code></span></p></td>
<td>photos views
</td>
</tr>
<tr>
<td><p><a name="PERSON-FIELD-favedate"></a><span class="term"><code class="literal">PERSON_FIELD_favedate</code></span></p></td>
<td>favorite date
</td>
</tr>
<tr>
<td><p><a name="PERSON-FIELD-FIRST:CAPS"></a><span class="term"><code class="literal">PERSON_FIELD_FIRST</code></span></p></td>
<td>internal offset to first in enum list
</td>
</tr>
<tr>
<td><p><a name="PERSON-FIELD-LAST:CAPS"></a><span class="term"><code class="literal">PERSON_FIELD_LAST</code></span></p></td>
<td>internal offset to last in enum list
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.18</div>
</body>
</html>