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
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
<!ENTITY version SYSTEM "version.xml">
]>
<refentry id="raptor-section-serializer">
<refmeta>
<refentrytitle role="top_of_page">Serializer</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>RAPTOR Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>Serializer</refname>
<refpurpose>RDF serializers - from RDF triples to a syntax</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
typedef <link linkend="raptor-serializer">raptor_serializer</link>;
<link linkend="raptor-serializer">raptor_serializer</link>* <link linkend="raptor-new-serializer">raptor_new_serializer</link> (const <link linkend="char">char</link> *name);
<link linkend="void">void</link> <link linkend="raptor-free-serializer">raptor_free_serializer</link> (<link linkend="raptor-serializer">raptor_serializer</link> *rdf_serializer);
<link linkend="int">int</link> <link linkend="raptor-serialize-start">raptor_serialize_start</link> (<link linkend="raptor-serializer">raptor_serializer</link> *rdf_serializer,
<link linkend="raptor-uri">raptor_uri</link> *uri,
<link linkend="raptor-iostream">raptor_iostream</link> *iostream);
<link linkend="int">int</link> <link linkend="raptor-serialize-start-to-filename">raptor_serialize_start_to_filename</link>
(<link linkend="raptor-serializer">raptor_serializer</link> *rdf_serializer,
const <link linkend="char">char</link> *filename);
<link linkend="int">int</link> <link linkend="raptor-serialize-start-to-string">raptor_serialize_start_to_string</link>
(<link linkend="raptor-serializer">raptor_serializer</link> *rdf_serializer,
<link linkend="raptor-uri">raptor_uri</link> *uri,
<link linkend="void">void</link> **string_p,
<link linkend="size-t">size_t</link> *length_p);
<link linkend="int">int</link> <link linkend="raptor-serialize-start-to-file-handle">raptor_serialize_start_to_file_handle</link>
(<link linkend="raptor-serializer">raptor_serializer</link> *rdf_serializer,
<link linkend="raptor-uri">raptor_uri</link> *uri,
<link linkend="FILE:CAPS">FILE</link> *fh);
<link linkend="int">int</link> <link linkend="raptor-serialize-set-namespace">raptor_serialize_set_namespace</link> (<link linkend="raptor-serializer">raptor_serializer</link> *rdf_serializer,
<link linkend="raptor-uri">raptor_uri</link> *uri,
unsigned <link linkend="char">char</link> *prefix);
<link linkend="int">int</link> <link linkend="raptor-serialize-set-namespace-from-namespace">raptor_serialize_set_namespace_from_namespace</link>
(<link linkend="raptor-serializer">raptor_serializer</link> *rdf_serializer,
<link linkend="raptor-namespace">raptor_namespace</link> *nspace);
<link linkend="int">int</link> <link linkend="raptor-serialize-statement">raptor_serialize_statement</link> (<link linkend="raptor-serializer">raptor_serializer</link> *rdf_serializer,
const <link linkend="raptor-statement">raptor_statement</link> *statement);
<link linkend="int">int</link> <link linkend="raptor-serialize-end">raptor_serialize_end</link> (<link linkend="raptor-serializer">raptor_serializer</link> *rdf_serializer);
<link linkend="raptor-iostream">raptor_iostream</link>* <link linkend="raptor-serializer-get-iostream">raptor_serializer_get_iostream</link>
(<link linkend="raptor-serializer">raptor_serializer</link> *serializer);
<link linkend="void">void</link> <link linkend="raptor-serializer-set-error-handler">raptor_serializer_set_error_handler</link>
(<link linkend="raptor-serializer">raptor_serializer</link> *serializer,
<link linkend="void">void</link> *user_data,
<link linkend="raptor-message-handler">raptor_message_handler</link> handler);
<link linkend="void">void</link> <link linkend="raptor-serializer-set-warning-handler">raptor_serializer_set_warning_handler</link>
(<link linkend="raptor-serializer">raptor_serializer</link> *serializer,
<link linkend="void">void</link> *user_data,
<link linkend="raptor-message-handler">raptor_message_handler</link> handler);
<link linkend="raptor-locator">raptor_locator</link>* <link linkend="raptor-serializer-get-locator">raptor_serializer_get_locator</link>
(<link linkend="raptor-serializer">raptor_serializer</link> *rdf_serializer);
<link linkend="int">int</link> <link linkend="raptor-serializer-features-enumerate">raptor_serializer_features_enumerate</link>
(const <link linkend="raptor-feature">raptor_feature</link> feature,
const <link linkend="char">char</link> **name,
<link linkend="raptor-uri">raptor_uri</link> **uri,
const <link linkend="char">char</link> **label);
<link linkend="int">int</link> <link linkend="raptor-serializer-set-feature">raptor_serializer_set_feature</link> (<link linkend="raptor-serializer">raptor_serializer</link> *serializer,
<link linkend="raptor-feature">raptor_feature</link> feature,
<link linkend="int">int</link> value);
<link linkend="int">int</link> <link linkend="raptor-serializer-set-feature-string">raptor_serializer_set_feature_string</link>
(<link linkend="raptor-serializer">raptor_serializer</link> *serializer,
<link linkend="raptor-feature">raptor_feature</link> feature,
unsigned <link linkend="char">char</link> *value);
<link linkend="int">int</link> <link linkend="raptor-serializer-get-feature">raptor_serializer_get_feature</link> (<link linkend="raptor-serializer">raptor_serializer</link> *serializer,
<link linkend="raptor-feature">raptor_feature</link> feature);
const unsigned <link linkend="char">char</link>* <link linkend="raptor-serializer-get-feature-string">raptor_serializer_get_feature_string</link>
(<link linkend="raptor-serializer">raptor_serializer</link> *serializer,
<link linkend="raptor-feature">raptor_feature</link> feature);
</synopsis>
</refsynopsisdiv>
<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>
The serializing class that allows creating a serializer for
writing a particular syntax to an output string, file, file
handle or user function (via <link linkend="raptor-iostream"><type>raptor_iostream</type></link>).
</para>
<para>
There are also methods to deal with handling errors, warnings and
returned triples as well as setting options (features)
that can adjust how serializing is performed.
</para>
</refsect1>
<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="raptor-serializer" role="typedef"/>raptor_serializer</title>
<indexterm><primary>raptor_serializer</primary></indexterm><programlisting>raptor_serializer* raptor_serializer;
</programlisting>
<para>
Raptor Serializer class</para>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="raptor-new-serializer" role="function"/>raptor_new_serializer ()</title>
<indexterm><primary>raptor_new_serializer</primary></indexterm><programlisting><link linkend="raptor-serializer">raptor_serializer</link>* raptor_new_serializer (const <link linkend="char">char</link> *name);</programlisting>
<para>
Constructor - create a new raptor_serializer object</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> the serializer name
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new <link linkend="raptor-serializer"><type>raptor_serializer</type></link> object or NULL on failure
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="raptor-free-serializer" role="function"/>raptor_free_serializer ()</title>
<indexterm><primary>raptor_free_serializer</primary></indexterm><programlisting><link linkend="void">void</link> raptor_free_serializer (<link linkend="raptor-serializer">raptor_serializer</link> *rdf_serializer);</programlisting>
<para>
Destructor - destroy a raptor_serializer object.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>rdf_serializer</parameter> :</term>
<listitem><simpara> <link linkend="raptor-serializer"><type>raptor_serializer</type></link> object
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="raptor-serialize-start" role="function"/>raptor_serialize_start ()</title>
<indexterm><primary>raptor_serialize_start</primary></indexterm><programlisting><link linkend="int">int</link> raptor_serialize_start (<link linkend="raptor-serializer">raptor_serializer</link> *rdf_serializer,
<link linkend="raptor-uri">raptor_uri</link> *uri,
<link linkend="raptor-iostream">raptor_iostream</link> *iostream);</programlisting>
<para>
Start serialization with given base URI</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>rdf_serializer</parameter> :</term>
<listitem><simpara> the <link linkend="raptor-serializer"><type>raptor_serializer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>uri</parameter> :</term>
<listitem><simpara> base URI or NULL if no base URI is required
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>iostream</parameter> :</term>
<listitem><simpara> <link linkend="raptor-iostream"><type>raptor_iostream</type></link> to write serialization to
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> non-0 on failure.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="raptor-serialize-start-to-filename" role="function"/>raptor_serialize_start_to_filename ()</title>
<indexterm><primary>raptor_serialize_start_to_filename</primary></indexterm><programlisting><link linkend="int">int</link> raptor_serialize_start_to_filename
(<link linkend="raptor-serializer">raptor_serializer</link> *rdf_serializer,
const <link linkend="char">char</link> *filename);</programlisting>
<para>
Start serializing to a filename.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>rdf_serializer</parameter> :</term>
<listitem><simpara> the <link linkend="raptor-serializer"><type>raptor_serializer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>filename</parameter> :</term>
<listitem><simpara> filename to serialize to
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> non-0 on failure.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="raptor-serialize-start-to-string" role="function"/>raptor_serialize_start_to_string ()</title>
<indexterm><primary>raptor_serialize_start_to_string</primary></indexterm><programlisting><link linkend="int">int</link> raptor_serialize_start_to_string
(<link linkend="raptor-serializer">raptor_serializer</link> *rdf_serializer,
<link linkend="raptor-uri">raptor_uri</link> *uri,
<link linkend="void">void</link> **string_p,
<link linkend="size-t">size_t</link> *length_p);</programlisting>
<para>
Start serializing to a string.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>rdf_serializer</parameter> :</term>
<listitem><simpara> the <link linkend="raptor-serializer"><type>raptor_serializer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>uri</parameter> :</term>
<listitem><simpara> base URI or NULL if no base URI is required
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>string_p</parameter> :</term>
<listitem><simpara> pointer to location to hold string
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>length_p</parameter> :</term>
<listitem><simpara> pointer to location to hold length of string (or NULL)
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> non-0 on failure.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="raptor-serialize-start-to-file-handle" role="function"/>raptor_serialize_start_to_file_handle ()</title>
<indexterm><primary>raptor_serialize_start_to_file_handle</primary></indexterm><programlisting><link linkend="int">int</link> raptor_serialize_start_to_file_handle
(<link linkend="raptor-serializer">raptor_serializer</link> *rdf_serializer,
<link linkend="raptor-uri">raptor_uri</link> *uri,
<link linkend="FILE:CAPS">FILE</link> *fh);</programlisting>
<para>
Start serializing to a FILE*.
</para>
<para>
NOTE: This does not fclose the handle when it is finished.
8</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>rdf_serializer</parameter> :</term>
<listitem><simpara> the <link linkend="raptor-serializer"><type>raptor_serializer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>uri</parameter> :</term>
<listitem><simpara> base URI or NULL if no base URI is required
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>fh</parameter> :</term>
<listitem><simpara> FILE* to serialize to
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> non-0 on failure.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="raptor-serialize-set-namespace" role="function"/>raptor_serialize_set_namespace ()</title>
<indexterm><primary>raptor_serialize_set_namespace</primary></indexterm><programlisting><link linkend="int">int</link> raptor_serialize_set_namespace (<link linkend="raptor-serializer">raptor_serializer</link> *rdf_serializer,
<link linkend="raptor-uri">raptor_uri</link> *uri,
unsigned <link linkend="char">char</link> *prefix);</programlisting>
<para>
set a namespace uri/prefix mapping for serializing.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>rdf_serializer</parameter> :</term>
<listitem><simpara> the <link linkend="raptor-serializer"><type>raptor_serializer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>uri</parameter> :</term>
<listitem><simpara> <link linkend="raptor-uri"><type>raptor_uri</type></link> of namespace
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>prefix</parameter> :</term>
<listitem><simpara> prefix to use
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> non-0 on failure.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="raptor-serialize-set-namespace-from-namespace" role="function"/>raptor_serialize_set_namespace_from_namespace ()</title>
<indexterm><primary>raptor_serialize_set_namespace_from_namespace</primary></indexterm><programlisting><link linkend="int">int</link> raptor_serialize_set_namespace_from_namespace
(<link linkend="raptor-serializer">raptor_serializer</link> *rdf_serializer,
<link linkend="raptor-namespace">raptor_namespace</link> *nspace);</programlisting>
<para>
Set a namespace uri/prefix mapping for serializing from an existing namespace.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>rdf_serializer</parameter> :</term>
<listitem><simpara> the <link linkend="raptor-serializer"><type>raptor_serializer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>nspace</parameter> :</term>
<listitem><simpara> <link linkend="raptor-namespace"><type>raptor_namespace</type></link> to set
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> non-0 on failure.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="raptor-serialize-statement" role="function"/>raptor_serialize_statement ()</title>
<indexterm><primary>raptor_serialize_statement</primary></indexterm><programlisting><link linkend="int">int</link> raptor_serialize_statement (<link linkend="raptor-serializer">raptor_serializer</link> *rdf_serializer,
const <link linkend="raptor-statement">raptor_statement</link> *statement);</programlisting>
<para>
Serialize a statement.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>rdf_serializer</parameter> :</term>
<listitem><simpara> the <link linkend="raptor-serializer"><type>raptor_serializer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>statement</parameter> :</term>
<listitem><simpara> <link linkend="raptor-statement"><type>raptor_statement</type></link> to serialize to a syntax
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> non-0 on failure.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="raptor-serialize-end" role="function"/>raptor_serialize_end ()</title>
<indexterm><primary>raptor_serialize_end</primary></indexterm><programlisting><link linkend="int">int</link> raptor_serialize_end (<link linkend="raptor-serializer">raptor_serializer</link> *rdf_serializer);</programlisting>
<para>
End a serialization.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>rdf_serializer</parameter> :</term>
<listitem><simpara> the <link linkend="raptor-serializer"><type>raptor_serializer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> non-0 on failure.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="raptor-serializer-get-iostream" role="function"/>raptor_serializer_get_iostream ()</title>
<indexterm><primary>raptor_serializer_get_iostream</primary></indexterm><programlisting><link linkend="raptor-iostream">raptor_iostream</link>* raptor_serializer_get_iostream
(<link linkend="raptor-serializer">raptor_serializer</link> *serializer);</programlisting>
<para>
Get the current serializer iostream.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>serializer</parameter> :</term>
<listitem><simpara> <link linkend="raptor-serializer"><type>raptor_serializer</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the serializer's current iostream or NULL if
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="raptor-serializer-set-error-handler" role="function"/>raptor_serializer_set_error_handler ()</title>
<indexterm><primary>raptor_serializer_set_error_handler</primary></indexterm><programlisting><link linkend="void">void</link> raptor_serializer_set_error_handler
(<link linkend="raptor-serializer">raptor_serializer</link> *serializer,
<link linkend="void">void</link> *user_data,
<link linkend="raptor-message-handler">raptor_message_handler</link> handler);</programlisting>
<para>
Set the serializer error handling function.
</para>
<para>
The function will receive callbacks when the serializer fails.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>serializer</parameter> :</term>
<listitem><simpara> the serializer
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara> user data to pass to function
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>handler</parameter> :</term>
<listitem><simpara> pointer to the function
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="raptor-serializer-set-warning-handler" role="function"/>raptor_serializer_set_warning_handler ()</title>
<indexterm><primary>raptor_serializer_set_warning_handler</primary></indexterm><programlisting><link linkend="void">void</link> raptor_serializer_set_warning_handler
(<link linkend="raptor-serializer">raptor_serializer</link> *serializer,
<link linkend="void">void</link> *user_data,
<link linkend="raptor-message-handler">raptor_message_handler</link> handler);</programlisting>
<para>
Set the serializer warning handling function.
</para>
<para>
The function will receive callbacks when the serializer fails.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>serializer</parameter> :</term>
<listitem><simpara> the serializer
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara> user data to pass to function
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>handler</parameter> :</term>
<listitem><simpara> pointer to the function
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="raptor-serializer-get-locator" role="function"/>raptor_serializer_get_locator ()</title>
<indexterm><primary>raptor_serializer_get_locator</primary></indexterm><programlisting><link linkend="raptor-locator">raptor_locator</link>* raptor_serializer_get_locator
(<link linkend="raptor-serializer">raptor_serializer</link> *rdf_serializer);</programlisting>
<para>
Get the serializer raptor locator object.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>rdf_serializer</parameter> :</term>
<listitem><simpara> raptor serializer
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> raptor locator
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="raptor-serializer-features-enumerate" role="function"/>raptor_serializer_features_enumerate ()</title>
<indexterm><primary>raptor_serializer_features_enumerate</primary></indexterm><programlisting><link linkend="int">int</link> raptor_serializer_features_enumerate
(const <link linkend="raptor-feature">raptor_feature</link> feature,
const <link linkend="char">char</link> **name,
<link linkend="raptor-uri">raptor_uri</link> **uri,
const <link linkend="char">char</link> **label);</programlisting>
<para>
Get list of serializer features.
</para>
<para>
If uri is not NULL, a pointer toa new raptor_uri is returned
that must be freed by the caller with <link linkend="raptor-free-uri"><function>raptor_free_uri()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>feature</parameter> :</term>
<listitem><simpara> feature enumeration (0+)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> pointer to store feature short name (or NULL)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>uri</parameter> :</term>
<listitem><simpara> pointer to store feature URI (or NULL)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>label</parameter> :</term>
<listitem><simpara> pointer to feature label (or NULL)
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> 0 on success, <0 on failure, >0 if feature is unknown
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="raptor-serializer-set-feature" role="function"/>raptor_serializer_set_feature ()</title>
<indexterm><primary>raptor_serializer_set_feature</primary></indexterm><programlisting><link linkend="int">int</link> raptor_serializer_set_feature (<link linkend="raptor-serializer">raptor_serializer</link> *serializer,
<link linkend="raptor-feature">raptor_feature</link> feature,
<link linkend="int">int</link> value);</programlisting>
<para>
Set serializer features with integer values.
</para>
<para>
The allowed features are available via <link linkend="raptor-features-enumerate"><function>raptor_features_enumerate()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>serializer</parameter> :</term>
<listitem><simpara> <link linkend="raptor-serializer"><type>raptor_serializer</type></link> serializer object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>feature</parameter> :</term>
<listitem><simpara> feature to set from enumerated <link linkend="raptor-feature"><type>raptor_feature</type></link> values
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value</parameter> :</term>
<listitem><simpara> integer feature value (0 or larger)
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> non 0 on failure or if the feature is unknown
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="raptor-serializer-set-feature-string" role="function"/>raptor_serializer_set_feature_string ()</title>
<indexterm><primary>raptor_serializer_set_feature_string</primary></indexterm><programlisting><link linkend="int">int</link> raptor_serializer_set_feature_string
(<link linkend="raptor-serializer">raptor_serializer</link> *serializer,
<link linkend="raptor-feature">raptor_feature</link> feature,
unsigned <link linkend="char">char</link> *value);</programlisting>
<para>
Set serializer features with string values.
</para>
<para>
The allowed features are available via <link linkend="raptor-serializer-features-enumerate"><function>raptor_serializer_features_enumerate()</function></link>.
If the feature type is integer, the value is interpreted as an integer.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>serializer</parameter> :</term>
<listitem><simpara> <link linkend="raptor-serializer"><type>raptor_serializer</type></link> serializer object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>feature</parameter> :</term>
<listitem><simpara> feature to set from enumerated <link linkend="raptor-feature"><type>raptor_feature</type></link> values
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value</parameter> :</term>
<listitem><simpara> feature value
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> non 0 on failure or if the feature is unknown
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="raptor-serializer-get-feature" role="function"/>raptor_serializer_get_feature ()</title>
<indexterm><primary>raptor_serializer_get_feature</primary></indexterm><programlisting><link linkend="int">int</link> raptor_serializer_get_feature (<link linkend="raptor-serializer">raptor_serializer</link> *serializer,
<link linkend="raptor-feature">raptor_feature</link> feature);</programlisting>
<para>
Get various serializer features.
</para>
<para>
The allowed features are available via <link linkend="raptor-features-enumerate"><function>raptor_features_enumerate()</function></link>.
</para>
<para>
Note: no feature value is negative</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>serializer</parameter> :</term>
<listitem><simpara> <link linkend="raptor-serializer"><type>raptor_serializer</type></link> serializer object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>feature</parameter> :</term>
<listitem><simpara> feature to get value
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> feature value or < 0 for an illegal feature
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="raptor-serializer-get-feature-string" role="function"/>raptor_serializer_get_feature_string ()</title>
<indexterm><primary>raptor_serializer_get_feature_string</primary></indexterm><programlisting>const unsigned <link linkend="char">char</link>* raptor_serializer_get_feature_string
(<link linkend="raptor-serializer">raptor_serializer</link> *serializer,
<link linkend="raptor-feature">raptor_feature</link> feature);</programlisting>
<para>
Get serializer features with string values.
</para>
<para>
The allowed features are available via <link linkend="raptor-features-enumerate"><function>raptor_features_enumerate()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>serializer</parameter> :</term>
<listitem><simpara> <link linkend="raptor-serializer"><type>raptor_serializer</type></link> serializer object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>feature</parameter> :</term>
<listitem><simpara> feature to get value
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> feature value or NULL for an illegal feature or no value
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
