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
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
<!ENTITY iptc-overview SYSTEM "overview.sgml">
<!ENTITY iptc-about SYSTEM "about.sgml">
<!ENTITY iptc-commandline SYSTEM "commandline.sgml">
<!ENTITY iptc-i18n SYSTEM "i18n.sgml">
<!ENTITY iptc-libjpeg SYSTEM "libjpeg.sgml">
<!ENTITY version SYSTEM "version.xml">
]>
<refentry id="libiptcdata-dataset">
<refmeta>
<refentrytitle role="top_of_page">Datasets</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBIPTCDATA Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>Datasets</refname>
<refpurpose>manipulating a tag identifier and its associated value</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="IptcDataSet">IptcDataSet</link>;
<link linkend="IptcDataSet">IptcDataSet</link>* <link linkend="iptc-dataset-new">iptc_dataset_new</link> (void);
<link linkend="IptcDataSet">IptcDataSet</link>* <link linkend="iptc-dataset-new-mem">iptc_dataset_new_mem</link> (<link linkend="IptcMem">IptcMem</link> *mem);
<link linkend="IptcDataSet">IptcDataSet</link>* <link linkend="iptc-dataset-copy">iptc_dataset_copy</link> (<link linkend="IptcDataSet">IptcDataSet</link> *dataset);
<link linkend="void">void</link> <link linkend="iptc-dataset-ref">iptc_dataset_ref</link> (<link linkend="IptcDataSet">IptcDataSet</link> *dataset);
<link linkend="void">void</link> <link linkend="iptc-dataset-unref">iptc_dataset_unref</link> (<link linkend="IptcDataSet">IptcDataSet</link> *dataset);
<link linkend="void">void</link> <link linkend="iptc-dataset-free">iptc_dataset_free</link> (<link linkend="IptcDataSet">IptcDataSet</link> *dataset);
<link linkend="IptcFormat">IptcFormat</link> <link linkend="iptc-dataset-get-format">iptc_dataset_get_format</link> (<link linkend="IptcDataSet">IptcDataSet</link> *dataset);
<link linkend="int">int</link> <link linkend="iptc-dataset-get-data">iptc_dataset_get_data</link> (<link linkend="IptcDataSet">IptcDataSet</link> *dataset,
unsigned <link linkend="char">char</link> *buf,
unsigned <link linkend="int">int</link> size);
unsigned <link linkend="int">int</link> <link linkend="iptc-dataset-get-value">iptc_dataset_get_value</link> (<link linkend="IptcDataSet">IptcDataSet</link> *dataset);
<link linkend="int">int</link> <link linkend="iptc-dataset-get-date">iptc_dataset_get_date</link> (<link linkend="IptcDataSet">IptcDataSet</link> *dataset,
<link linkend="int">int</link> *year,
<link linkend="int">int</link> *month,
<link linkend="int">int</link> *day);
<link linkend="int">int</link> <link linkend="iptc-dataset-get-time">iptc_dataset_get_time</link> (<link linkend="IptcDataSet">IptcDataSet</link> *dataset,
<link linkend="int">int</link> *hour,
<link linkend="int">int</link> *min,
<link linkend="int">int</link> *sec,
<link linkend="int">int</link> *tz);
<link linkend="void">void</link> <link linkend="iptc-dataset-set-tag">iptc_dataset_set_tag</link> (<link linkend="IptcDataSet">IptcDataSet</link> *dataset,
<link linkend="IptcRecord">IptcRecord</link> record,
<link linkend="IptcTag">IptcTag</link> tag);
enum <link linkend="IptcValidate">IptcValidate</link>;
<link linkend="int">int</link> <link linkend="iptc-dataset-set-data">iptc_dataset_set_data</link> (<link linkend="IptcDataSet">IptcDataSet</link> *dataset,
unsigned <link linkend="char">char</link> *buf,
unsigned <link linkend="int">int</link> size,
<link linkend="IptcValidate">IptcValidate</link> validate);
<link linkend="int">int</link> <link linkend="iptc-dataset-set-value">iptc_dataset_set_value</link> (<link linkend="IptcDataSet">IptcDataSet</link> *dataset,
unsigned <link linkend="int">int</link> value,
<link linkend="IptcValidate">IptcValidate</link> validate);
<link linkend="int">int</link> <link linkend="iptc-dataset-set-date">iptc_dataset_set_date</link> (<link linkend="IptcDataSet">IptcDataSet</link> *dataset,
<link linkend="int">int</link> year,
<link linkend="int">int</link> month,
<link linkend="int">int</link> day,
<link linkend="IptcValidate">IptcValidate</link> validate);
<link linkend="int">int</link> <link linkend="iptc-dataset-set-time">iptc_dataset_set_time</link> (<link linkend="IptcDataSet">IptcDataSet</link> *dataset,
<link linkend="int">int</link> hour,
<link linkend="int">int</link> min,
<link linkend="int">int</link> sec,
<link linkend="int">int</link> tz,
<link linkend="IptcValidate">IptcValidate</link> validate);
const <link linkend="char">char</link>* <link linkend="iptc-dataset-get-as-str">iptc_dataset_get_as_str</link> (<link linkend="IptcDataSet">IptcDataSet</link> *dataset,
<link linkend="char">char</link> *buf,
unsigned <link linkend="int">int</link> size);
<link linkend="void">void</link> <link linkend="iptc-dataset-dump">iptc_dataset_dump</link> (<link linkend="IptcDataSet">IptcDataSet</link> *dataset,
unsigned <link linkend="int">int</link> indent);
</synopsis>
</refsynopsisdiv>
<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>
The <link linkend="IptcDataSet"><type>IptcDataSet</type></link> object contains a record number, dataset number, and
data. The record and dataset (tag) number uniquely define the purpose of
the dataset according to the IPTC IIM specification. The data is the
contents of the tag.
</para>
</refsect1>
<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="IptcDataSet" role="struct"/>IptcDataSet</title>
<indexterm><primary>IptcDataSet</primary></indexterm><programlisting>typedef struct {
IptcRecord record;
IptcTag tag;
const IptcTagInfo * info;
unsigned char *data;
unsigned int size;
/* Data containing this dataset */
IptcData *parent;
IptcDataSetPrivate *priv;
} IptcDataSet;
</programlisting>
<para>
An IPTC dataset, which associates a record/tag pair with a value.
</para><variablelist role="struct">
<varlistentry>
<term><link linkend="IptcRecord">IptcRecord</link> <structfield>record</structfield>;</term>
<listitem><simpara>the record number
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="IptcTag">IptcTag</link> <structfield>tag</structfield>;</term>
<listitem><simpara>the dataset number
</simpara></listitem>
</varlistentry>
<varlistentry>
<term>const <link linkend="IptcTagInfo">IptcTagInfo</link> *<structfield>info</structfield>;</term>
<listitem><simpara>information about the tag from the IPTC IIM specification
</simpara></listitem>
</varlistentry>
<varlistentry>
<term>unsigned <link linkend="char">char</link> *<structfield>data</structfield>;</term>
<listitem><simpara>the value of the tag
</simpara></listitem>
</varlistentry>
<varlistentry>
<term>unsigned <link linkend="int">int</link> <structfield>size</structfield>;</term>
<listitem><simpara>the length of <parameter>data</parameter> in bytes
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="IptcData">IptcData</link> *<structfield>parent</structfield>;</term>
<listitem><simpara>the <link linkend="IptcData"><type>IptcData</type></link> object that contains this dataset or NULL
if it is not contained
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="IptcDataSetPrivate">IptcDataSetPrivate</link> *<structfield>priv</structfield>;</term>
<listitem><simpara>private data
</simpara></listitem>
</varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="iptc-dataset-new" role="function"/>iptc_dataset_new ()</title>
<indexterm><primary>iptc_dataset_new</primary></indexterm><programlisting><link linkend="IptcDataSet">IptcDataSet</link>* iptc_dataset_new (void);</programlisting>
<para>
Allocates a new dataset, which is initialized to be empty (undefined tag and
empty value). The default memory allocation functions (malloc, etc.) are
used. If you need custom memory management functions, use
<link linkend="iptc-dataset-new-mem"><function>iptc_dataset_new_mem()</function></link> instead. This allocation will set the <link linkend="IptcDataSet"><type>IptcDataSet</type></link>
refcount to 1, so use <link linkend="iptc-dataset-unref"><function>iptc_dataset_unref()</function></link> when finished with the pointer.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> pointer to the new <link linkend="IptcDataSet"><type>IptcDataSet</type></link> object, NULL on error
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="iptc-dataset-new-mem" role="function"/>iptc_dataset_new_mem ()</title>
<indexterm><primary>iptc_dataset_new_mem</primary></indexterm><programlisting><link linkend="IptcDataSet">IptcDataSet</link>* iptc_dataset_new_mem (<link linkend="IptcMem">IptcMem</link> *mem);</programlisting>
<para>
Allocates a new dataset, which is initialized to be empty (undefined tag and
empty value), using custom memory management functions. This allocation
will set the <link linkend="IptcDataSet"><type>IptcDataSet</type></link> refcount to 1, so use <link linkend="iptc-dataset-unref"><function>iptc_dataset_unref()</function></link> when
finished with the pointer.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>mem</parameter> :</term>
<listitem><simpara> Pointer to an <link linkend="IptcMem"><type>IptcMem</type></link> object that defines custom memory managment
functions. The refcount of <parameter>mem</parameter> will be incremented. It is decremented
when the returned <link linkend="IptcDataSet"><type>IptcDataSet</type></link> object is freed.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> pointer to the new <link linkend="IptcDataSet"><type>IptcDataSet</type></link> object, NULL on error
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="iptc-dataset-copy" role="function"/>iptc_dataset_copy ()</title>
<indexterm><primary>iptc_dataset_copy</primary></indexterm><programlisting><link linkend="IptcDataSet">IptcDataSet</link>* iptc_dataset_copy (<link linkend="IptcDataSet">IptcDataSet</link> *dataset);</programlisting>
<para>
Allocates a new dataset and copies the contents of an existing dataset
into the new one. Copied data includes record, tag, and the data payload.
This is a "deep copy" so that a new copy of the data payload is created,
not just a pointer duplication. The new dataset has no parent collection,
regardless of the parent of the copied dataset. This allocation will set
the <link linkend="IptcDataSet"><type>IptcDataSet</type></link> refcount to 1, so use <link linkend="iptc-dataset-unref"><function>iptc_dataset_unref()</function></link> when finished
with the pointer.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>dataset</parameter> :</term>
<listitem><simpara> the dataset to duplicate
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> pointer to the new <link linkend="IptcDataSet"><type>IptcDataSet</type></link> object, NULL on error
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="iptc-dataset-ref" role="function"/>iptc_dataset_ref ()</title>
<indexterm><primary>iptc_dataset_ref</primary></indexterm><programlisting><link linkend="void">void</link> iptc_dataset_ref (<link linkend="IptcDataSet">IptcDataSet</link> *dataset);</programlisting>
<para>
Increments the reference count of an <link linkend="IptcDataSet"><type>IptcDataSet</type></link> object. This function
should be called whenever a copy of a pointer is made by the application.
<link linkend="iptc-dataset-unref"><function>iptc_dataset_unref()</function></link> can then be used when the pointer is no longer needed
to ensure that the object is freed once the object is completely unused.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>dataset</parameter> :</term>
<listitem><simpara> the referenced pointer
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="iptc-dataset-unref" role="function"/>iptc_dataset_unref ()</title>
<indexterm><primary>iptc_dataset_unref</primary></indexterm><programlisting><link linkend="void">void</link> iptc_dataset_unref (<link linkend="IptcDataSet">IptcDataSet</link> *dataset);</programlisting>
<para>
Decrements the reference count of an <link linkend="IptcDataSet"><type>IptcDataSet</type></link> object. The object will
automatically be freed when the count reaches 0. This function should
be called whenever a pointer is no longer needed by an application. It
is also good practice to set the local copy of the pointer to NULL to
shield against accidently reusing the value.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>dataset</parameter> :</term>
<listitem><simpara> the unreferenced pointer
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="iptc-dataset-free" role="function"/>iptc_dataset_free ()</title>
<indexterm><primary>iptc_dataset_free</primary></indexterm><programlisting><link linkend="void">void</link> iptc_dataset_free (<link linkend="IptcDataSet">IptcDataSet</link> *dataset);</programlisting>
<para>
Frees an <link linkend="IptcDataSet"><type>IptcDataSet</type></link> object and its contained data. This function should
be used only for error handling since <link linkend="iptc-dataset-unref"><function>iptc_dataset_unref()</function></link> provides a
safer mechanism for freeing that allows multiple components to have access
to an object.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>dataset</parameter> :</term>
<listitem><simpara> the object to free
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="iptc-dataset-get-format" role="function"/>iptc_dataset_get_format ()</title>
<indexterm><primary>iptc_dataset_get_format</primary></indexterm><programlisting><link linkend="IptcFormat">IptcFormat</link> iptc_dataset_get_format (<link linkend="IptcDataSet">IptcDataSet</link> *dataset);</programlisting>
<para>
Retrieves the data format of a dataset tag according to the IPTC
specification.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>dataset</parameter> :</term>
<listitem><simpara> pointer to an <link linkend="IptcDataSet"><type>IptcDataSet</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the format of the tag which will be <link linkend="IPTC-FORMAT-UNKNOWN:CAPS"><literal>IPTC_FORMAT_UNKNOWN</literal></link> if the tag
number has not been set or the tag is not in the specification
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="iptc-dataset-get-data" role="function"/>iptc_dataset_get_data ()</title>
<indexterm><primary>iptc_dataset_get_data</primary></indexterm><programlisting><link linkend="int">int</link> iptc_dataset_get_data (<link linkend="IptcDataSet">IptcDataSet</link> *dataset,
unsigned <link linkend="char">char</link> *buf,
unsigned <link linkend="int">int</link> size);</programlisting>
<para>
Copies the value of a dataset into a buffer. If the buffer has extra
space, the data will be NULL-terminated to assist in dealing with
strings.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>dataset</parameter> :</term>
<listitem><simpara> pointer to an <link linkend="IptcDataSet"><type>IptcDataSet</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>buf</parameter> :</term>
<listitem><simpara> buffer to which the data will be copied
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>size</parameter> :</term>
<listitem><simpara> maximum size of the buffer
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the number of bytes copied, or -1 on failure
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="iptc-dataset-get-value" role="function"/>iptc_dataset_get_value ()</title>
<indexterm><primary>iptc_dataset_get_value</primary></indexterm><programlisting>unsigned <link linkend="int">int</link> iptc_dataset_get_value (<link linkend="IptcDataSet">IptcDataSet</link> *dataset);</programlisting>
<para>
Gets the value of a dataset as an unsigned integer. This function is meant
to be used when the format of a tag is a byte, short, or long. Undefined
results occur when this function is used on a tag containing data in another
format.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>dataset</parameter> :</term>
<listitem><simpara> pointer to an <link linkend="IptcDataSet"><type>IptcDataSet</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> value contained in the dataset
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="iptc-dataset-get-date" role="function"/>iptc_dataset_get_date ()</title>
<indexterm><primary>iptc_dataset_get_date</primary></indexterm><programlisting><link linkend="int">int</link> iptc_dataset_get_date (<link linkend="IptcDataSet">IptcDataSet</link> *dataset,
<link linkend="int">int</link> *year,
<link linkend="int">int</link> *month,
<link linkend="int">int</link> *day);</programlisting>
<para>
Interprets the contents of the dataset as an IPTC date and parses
the year, month, and day into the given output variables. If any
variable is NULL, that value is skipped. IPTC dates are stored as
a string in the format YYYYMMDD.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>dataset</parameter> :</term>
<listitem><simpara> pointer to an <link linkend="IptcDataSet"><type>IptcDataSet</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>year</parameter> :</term>
<listitem><simpara> output variable to store the year (0-9999)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>month</parameter> :</term>
<listitem><simpara> output variable to store the month (1-12)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>day</parameter> :</term>
<listitem><simpara> output variable to store the day of the month (1-31)
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> 0 on success; -1 on failure
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="iptc-dataset-get-time" role="function"/>iptc_dataset_get_time ()</title>
<indexterm><primary>iptc_dataset_get_time</primary></indexterm><programlisting><link linkend="int">int</link> iptc_dataset_get_time (<link linkend="IptcDataSet">IptcDataSet</link> *dataset,
<link linkend="int">int</link> *hour,
<link linkend="int">int</link> *min,
<link linkend="int">int</link> *sec,
<link linkend="int">int</link> *tz);</programlisting>
<para>
Interprets the contents of the dataset as an IPTC time and parses
the hour, minute, second, and timezone into the given output variables.
If any variable is NULL, that value is skipped. IPTC times are stored as
a string in the format HHMMSS±HHMM.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>dataset</parameter> :</term>
<listitem><simpara> pointer to an <link linkend="IptcDataSet"><type>IptcDataSet</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>hour</parameter> :</term>
<listitem><simpara> output variable to store the hour (0-23)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>min</parameter> :</term>
<listitem><simpara> output variable to store the minute (0-59)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>sec</parameter> :</term>
<listitem><simpara> output variable to store the second (0-59)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>tz</parameter> :</term>
<listitem><simpara> output variable to store the timezone (offset in minutes from GMT)
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> 0 on success; -1 on failure
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="iptc-dataset-set-tag" role="function"/>iptc_dataset_set_tag ()</title>
<indexterm><primary>iptc_dataset_set_tag</primary></indexterm><programlisting><link linkend="void">void</link> iptc_dataset_set_tag (<link linkend="IptcDataSet">IptcDataSet</link> *dataset,
<link linkend="IptcRecord">IptcRecord</link> record,
<link linkend="IptcTag">IptcTag</link> tag);</programlisting>
<para>
Sets the record and tag number for a dataset object. Each record/tag pair
is assigned a specific meaning by the IPTC IIM specification. This function
allows any value to be set for the dataset object, regardless of its
meaning. This function can also be used to change the record/tag number in
place even if it has been already set.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>dataset</parameter> :</term>
<listitem><simpara> dataset for which the record/tag numbers should be set
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>record</parameter> :</term>
<listitem><simpara> record number of the dataset
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>tag</parameter> :</term>
<listitem><simpara> tag (dataset number) of the dataset
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="IptcValidate" role="enum"/>enum IptcValidate</title>
<indexterm><primary>IptcValidate</primary></indexterm><programlisting>typedef enum {
IPTC_DONT_VALIDATE = 0,
IPTC_VALIDATE = 1
} IptcValidate;
</programlisting>
<para>
Whether the value of a dataset should be validated to meet the IPTC
IIM specification.
</para><variablelist role="enum">
<varlistentry>
<term><anchor id="IPTC-DONT-VALIDATE:CAPS" role="constant"/><literal>IPTC_DONT_VALIDATE</literal></term>
<listitem><simpara>do not check the value against the specification
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="IPTC-VALIDATE:CAPS" role="constant"/><literal>IPTC_VALIDATE</literal></term>
<listitem><simpara>check the value against the specification
</simpara></listitem>
</varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="iptc-dataset-set-data" role="function"/>iptc_dataset_set_data ()</title>
<indexterm><primary>iptc_dataset_set_data</primary></indexterm><programlisting><link linkend="int">int</link> iptc_dataset_set_data (<link linkend="IptcDataSet">IptcDataSet</link> *dataset,
unsigned <link linkend="char">char</link> *buf,
unsigned <link linkend="int">int</link> size,
<link linkend="IptcValidate">IptcValidate</link> validate);</programlisting>
<para>
Copies bytes from a buffer as the new value for a dataset. This is the
correct method for setting a dataset value to a string or raw binary
sequence. The length of a string should be specified without the trailing
NULL. New memory is allocated for the value and <parameter>size</parameter> bytes are copied
from <parameter>buf</parameter> into this new memory (which is freed when the dataset is freed or
when a new value is set). If <parameter>validate</parameter> is set to <link linkend="IPTC-VALIDATE:CAPS"><literal>IPTC_VALIDATE</literal></link>, the buffer
will only be copied if the size does not violate the IPTC specification (it
must not be too long or too short). This check is ignored if the dataset's
tag is undefined or no information from the specification is available for
that tag.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>dataset</parameter> :</term>
<listitem><simpara> dataset for which the value should be set
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>buf</parameter> :</term>
<listitem><simpara> buffer containing the value
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>size</parameter> :</term>
<listitem><simpara> number of bytes to copy
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>validate</parameter> :</term>
<listitem><simpara> whether or not the passed value should be validated against
the IPTC specification for this dataset's tag.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> -1 on error, 0 if validation failed, the number of bytes copied
on success
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="iptc-dataset-set-value" role="function"/>iptc_dataset_set_value ()</title>
<indexterm><primary>iptc_dataset_set_value</primary></indexterm><programlisting><link linkend="int">int</link> iptc_dataset_set_value (<link linkend="IptcDataSet">IptcDataSet</link> *dataset,
unsigned <link linkend="int">int</link> value,
<link linkend="IptcValidate">IptcValidate</link> validate);</programlisting>
<para>
Sets the value of a dataset as an integer. This is the correct method for
setting a dataset value with type byte, short, or long. If <parameter>validate</parameter> is
set to <link linkend="IPTC-VALIDATE:CAPS"><literal>IPTC_VALIDATE</literal></link>, the value will only be set if the tag has type
byte, short, or long according the IPTC specification. This check is
ignored if the dataset's tag is undefined or no information from the
specification is available for that tag.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>dataset</parameter> :</term>
<listitem><simpara> dataset for which the value should be set
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value</parameter> :</term>
<listitem><simpara> value for the dataset
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>validate</parameter> :</term>
<listitem><simpara> whether or not the passed value should be validated against
the IPTC specification for this dataset's tag.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> -1 on error, 0 if validation failed, the number of bytes copied
on success
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="iptc-dataset-set-date" role="function"/>iptc_dataset_set_date ()</title>
<indexterm><primary>iptc_dataset_set_date</primary></indexterm><programlisting><link linkend="int">int</link> iptc_dataset_set_date (<link linkend="IptcDataSet">IptcDataSet</link> *dataset,
<link linkend="int">int</link> year,
<link linkend="int">int</link> month,
<link linkend="int">int</link> day,
<link linkend="IptcValidate">IptcValidate</link> validate);</programlisting>
<para>
Sets the contents of the dataset to be a date with the specified value.
IPTC dates are stored as a string in the format YYYYMMDD.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>dataset</parameter> :</term>
<listitem><simpara> pointer to an <link linkend="IptcDataSet"><type>IptcDataSet</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>year</parameter> :</term>
<listitem><simpara> the year (0-9999)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>month</parameter> :</term>
<listitem><simpara> the month (1-12)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>day</parameter> :</term>
<listitem><simpara> the day of the month (1-31)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>validate</parameter> :</term>
<listitem><simpara> if set to <link linkend="IPTC-VALIDATE:CAPS"><literal>IPTC_VALIDATE</literal></link>, the dataset date will only be set if
the IPTC specification says it is of type date.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the number of bytes written on success (always 8 in this case); 0
if validation fails; -1 for other failures
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="iptc-dataset-set-time" role="function"/>iptc_dataset_set_time ()</title>
<indexterm><primary>iptc_dataset_set_time</primary></indexterm><programlisting><link linkend="int">int</link> iptc_dataset_set_time (<link linkend="IptcDataSet">IptcDataSet</link> *dataset,
<link linkend="int">int</link> hour,
<link linkend="int">int</link> min,
<link linkend="int">int</link> sec,
<link linkend="int">int</link> tz,
<link linkend="IptcValidate">IptcValidate</link> validate);</programlisting>
<para>
Sets the contents of the dataset to be a time with the specified value.
IPTC times are stored as a string in the format HHMMSS±HHMM.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>dataset</parameter> :</term>
<listitem><simpara> pointer to an <link linkend="IptcDataSet"><type>IptcDataSet</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>hour</parameter> :</term>
<listitem><simpara> the hour (0-23)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>min</parameter> :</term>
<listitem><simpara> the minutes (0-59)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>sec</parameter> :</term>
<listitem><simpara> the seconds (0-61)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>tz</parameter> :</term>
<listitem><simpara> the timezone expressed as the number of minutes offset from GMT.
For example, EST is -300 (-5 hours).
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>validate</parameter> :</term>
<listitem><simpara> if set to <link linkend="IPTC-VALIDATE:CAPS"><literal>IPTC_VALIDATE</literal></link>, the dataset time will only be set if
the IPTC specification says it is of type time.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the number of bytes written on success (always 11 in this case); 0
if validation fails; -1 for other failures
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="iptc-dataset-get-as-str" role="function"/>iptc_dataset_get_as_str ()</title>
<indexterm><primary>iptc_dataset_get_as_str</primary></indexterm><programlisting>const <link linkend="char">char</link>* iptc_dataset_get_as_str (<link linkend="IptcDataSet">IptcDataSet</link> *dataset,
<link linkend="char">char</link> *buf,
unsigned <link linkend="int">int</link> size);</programlisting>
<para>
Copies the value of a dataset into a buffer as a printable, NULL-terminated
string. For tags of type byte, short, or long, the value will be formatted
as a string. For tags of type string (including dates and times), the
string will simply be copied into the output buffer. For tags containing
binary data, the data will be formatted as a string in hexidecimal.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>dataset</parameter> :</term>
<listitem><simpara> pointer to an <link linkend="IptcDataSet"><type>IptcDataSet</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>buf</parameter> :</term>
<listitem><simpara> buffer to which the string will be copied
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>size</parameter> :</term>
<listitem><simpara> maximum size of the buffer
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the output string on success, or NULL on failure
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="iptc-dataset-dump" role="function"/>iptc_dataset_dump ()</title>
<indexterm><primary>iptc_dataset_dump</primary></indexterm><programlisting><link linkend="void">void</link> iptc_dataset_dump (<link linkend="IptcDataSet">IptcDataSet</link> *dataset,
unsigned <link linkend="int">int</link> indent);</programlisting>
<para>
A debugging aid that prints out the contents of a dataset to
standard output.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>dataset</parameter> :</term>
<listitem><simpara> dataset to print
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>indent</parameter> :</term>
<listitem><simpara> indentation level of the printout
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1><refsect2 /><refsect2 /></refsect1>
</refentry>
|
