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
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Tag Specifications</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
<link rel="start" href="index.html" title="libiptcdata Reference Manual">
<link rel="up" href="ch01.html" title="IPTC Data Manipulation">
<link rel="prev" href="libiptcdata-dataset.html" title="Datasets">
<link rel="next" href="ch02.html" title="Format-specific Functions">
<meta name="generator" content="GTK-Doc V1.9 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="ch01.html" title="IPTC Data Manipulation">
<link rel="chapter" href="ch02.html" title="Format-specific Functions">
<link rel="chapter" href="ch03.html" title="Helper Functions">
</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="libiptcdata-dataset.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></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">libiptcdata Reference Manual</th>
<td><a accesskey="n" href="ch02.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2617076" class="shortcut">Top</a>
 | 
<a href="#id2580163" class="shortcut">Description</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="libiptcdata-tag"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2617076"></a><span class="refentrytitle">Tag Specifications</span>
</h2>
<p>Tag Specifications — querying tag usage information from the IPTC IIM specification</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
enum <a class="link" href="libiptcdata-tag.html#IptcRecord">IptcRecord</a>;
enum <a class="link" href="libiptcdata-tag.html#IptcTag">IptcTag</a>;
<a class="link" href="libiptcdata-tag.html#IptcTagInfo">IptcTagInfo</a>;
enum <a class="link" href="libiptcdata-tag.html#IptcFormat">IptcFormat</a>;
enum <a class="link" href="libiptcdata-tag.html#IptcMandatory">IptcMandatory</a>;
enum <a class="link" href="libiptcdata-tag.html#IptcRepeatable">IptcRepeatable</a>;
const char* <a class="link" href="libiptcdata-tag.html#iptc-tag-get-name">iptc_tag_get_name</a> (<a class="link" href="libiptcdata-tag.html#IptcRecord">IptcRecord</a> record,
<a class="link" href="libiptcdata-tag.html#IptcTag">IptcTag</a> tag);
char* <a class="link" href="libiptcdata-tag.html#iptc-tag-get-title">iptc_tag_get_title</a> (<a class="link" href="libiptcdata-tag.html#IptcRecord">IptcRecord</a> record,
<a class="link" href="libiptcdata-tag.html#IptcTag">IptcTag</a> tag);
char* <a class="link" href="libiptcdata-tag.html#iptc-tag-get-description">iptc_tag_get_description</a> (<a class="link" href="libiptcdata-tag.html#IptcRecord">IptcRecord</a> record,
<a class="link" href="libiptcdata-tag.html#IptcTag">IptcTag</a> tag);
const <a class="link" href="libiptcdata-tag.html#IptcTagInfo">IptcTagInfo</a>* <a class="link" href="libiptcdata-tag.html#iptc-tag-get-info">iptc_tag_get_info</a> (<a class="link" href="libiptcdata-tag.html#IptcRecord">IptcRecord</a> record,
<a class="link" href="libiptcdata-tag.html#IptcTag">IptcTag</a> tag);
char* <a class="link" href="libiptcdata-tag.html#iptc-format-get-name">iptc_format_get_name</a> (<a class="link" href="libiptcdata-tag.html#IptcFormat">IptcFormat</a> format);
int <a class="link" href="libiptcdata-tag.html#iptc-tag-find-by-name">iptc_tag_find_by_name</a> (const char *name,
<a class="link" href="libiptcdata-tag.html#IptcRecord">IptcRecord</a> *record,
<a class="link" href="libiptcdata-tag.html#IptcTag">IptcTag</a> *tag);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2580163"></a><h2>Description</h2>
<p>
These functions allow queries to the <a class="ulink" href="http://www.iptc.org/IIM" target="_top">IPTC IIM
specification</a> which contains information about the purpose of each IPTC
tag, along with any requirements such as maximum/minimum data length, data type,
repeatability and whether the tag is mandatory.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2580187"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2580198"></a><h3>
<a name="IptcRecord"></a>enum IptcRecord</h3>
<a class="indexterm" name="id2587313"></a><pre class="programlisting">typedef enum {
IPTC_RECORD_OBJECT_ENV = 1,
IPTC_RECORD_APP_2 = 2,
IPTC_RECORD_APP_3 = 3,
IPTC_RECORD_APP_4 = 4,
IPTC_RECORD_APP_5 = 5,
IPTC_RECORD_APP_6 = 6,
IPTC_RECORD_PREOBJ_DATA = 7,
IPTC_RECORD_OBJ_DATA = 8,
IPTC_RECORD_POSTOBJ_DATA = 9
} IptcRecord;
</pre>
<p>
The record number that, together with the tag number (<a class="link" href="libiptcdata-tag.html#IptcTag"><span class="type">IptcTag</span></a>),
uniquely identifies the purpose of a tag.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><a name="IPTC-RECORD-OBJECT-ENV:CAPS"></a><code class="literal">IPTC_RECORD_OBJECT_ENV</code></span></p></td>
<td>the record used for file information such
as file format, version, unique identifier, etc. This is often
not used for photo-management applications.
</td>
</tr>
<tr>
<td><p><span class="term"><a name="IPTC-RECORD-APP-2:CAPS"></a><code class="literal">IPTC_RECORD_APP_2</code></span></p></td>
<td>the record used for application-specific tags
such as Caption, Keywords, etc.
</td>
</tr>
<tr>
<td><p><span class="term"><a name="IPTC-RECORD-APP-3:CAPS"></a><code class="literal">IPTC_RECORD_APP_3</code></span></p></td>
<td>application-specific tags
</td>
</tr>
<tr>
<td><p><span class="term"><a name="IPTC-RECORD-APP-4:CAPS"></a><code class="literal">IPTC_RECORD_APP_4</code></span></p></td>
<td>application-specific tags
</td>
</tr>
<tr>
<td><p><span class="term"><a name="IPTC-RECORD-APP-5:CAPS"></a><code class="literal">IPTC_RECORD_APP_5</code></span></p></td>
<td>application-specific tags
</td>
</tr>
<tr>
<td><p><span class="term"><a name="IPTC-RECORD-APP-6:CAPS"></a><code class="literal">IPTC_RECORD_APP_6</code></span></p></td>
<td>application-specific tags
</td>
</tr>
<tr>
<td><p><span class="term"><a name="IPTC-RECORD-PREOBJ-DATA:CAPS"></a><code class="literal">IPTC_RECORD_PREOBJ_DATA</code></span></p></td>
<td>contains information about an encapsulated file
</td>
</tr>
<tr>
<td><p><span class="term"><a name="IPTC-RECORD-OBJ-DATA:CAPS"></a><code class="literal">IPTC_RECORD_OBJ_DATA</code></span></p></td>
<td>the encapsulated file data (usually not used)
</td>
</tr>
<tr>
<td><p><span class="term"><a name="IPTC-RECORD-POSTOBJ-DATA:CAPS"></a><code class="literal">IPTC_RECORD_POSTOBJ_DATA</code></span></p></td>
<td>followup information about an encapsulated file
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2576758"></a><h3>
<a name="IptcTag"></a>enum IptcTag</h3>
<a class="indexterm" name="id2576770"></a><pre class="programlisting">typedef enum {
IPTC_TAG_MODEL_VERSION = 0, /* Begin record 1 tags */
IPTC_TAG_DESTINATION = 5,
IPTC_TAG_FILE_FORMAT = 20,
IPTC_TAG_FILE_VERSION = 22,
IPTC_TAG_SERVICE_ID = 30,
IPTC_TAG_ENVELOPE_NUM = 40,
IPTC_TAG_PRODUCT_ID = 50,
IPTC_TAG_ENVELOPE_PRIORITY = 60,
IPTC_TAG_DATE_SENT = 70,
IPTC_TAG_TIME_SENT = 80,
IPTC_TAG_CHARACTER_SET = 90,
IPTC_TAG_UNO = 100,
IPTC_TAG_ARM_ID = 120,
IPTC_TAG_ARM_VERSION = 122, /* End record 1 tags */
IPTC_TAG_RECORD_VERSION = 0, /* Begin record 2 tags */
IPTC_TAG_OBJECT_TYPE = 3,
IPTC_TAG_OBJECT_ATTRIBUTE = 4,
IPTC_TAG_OBJECT_NAME = 5,
IPTC_TAG_EDIT_STATUS = 7,
IPTC_TAG_EDITORIAL_UPDATE = 8,
IPTC_TAG_URGENCY = 10,
IPTC_TAG_SUBJECT_REFERENCE = 12,
IPTC_TAG_CATEGORY = 15,
IPTC_TAG_SUPPL_CATEGORY = 20,
IPTC_TAG_FIXTURE_ID = 22,
IPTC_TAG_KEYWORDS = 25,
IPTC_TAG_CONTENT_LOC_CODE = 26,
IPTC_TAG_CONTENT_LOC_NAME = 27,
IPTC_TAG_RELEASE_DATE = 30,
IPTC_TAG_RELEASE_TIME = 35,
IPTC_TAG_EXPIRATION_DATE = 37,
IPTC_TAG_EXPIRATION_TIME = 38,
IPTC_TAG_SPECIAL_INSTRUCTIONS = 40,
IPTC_TAG_ACTION_ADVISED = 42,
IPTC_TAG_REFERENCE_SERVICE = 45,
IPTC_TAG_REFERENCE_DATE = 47,
IPTC_TAG_REFERENCE_NUMBER = 50,
IPTC_TAG_DATE_CREATED = 55,
IPTC_TAG_TIME_CREATED = 60,
IPTC_TAG_DIGITAL_CREATION_DATE = 62,
IPTC_TAG_DIGITAL_CREATION_TIME = 63,
IPTC_TAG_ORIGINATING_PROGRAM = 65,
IPTC_TAG_PROGRAM_VERSION = 70,
IPTC_TAG_OBJECT_CYCLE = 75,
IPTC_TAG_BYLINE = 80,
IPTC_TAG_BYLINE_TITLE = 85,
IPTC_TAG_CITY = 90,
IPTC_TAG_SUBLOCATION = 92,
IPTC_TAG_STATE = 95,
IPTC_TAG_COUNTRY_CODE = 100,
IPTC_TAG_COUNTRY_NAME = 101,
IPTC_TAG_ORIG_TRANS_REF = 103,
IPTC_TAG_HEADLINE = 105,
IPTC_TAG_CREDIT = 110,
IPTC_TAG_SOURCE = 115,
IPTC_TAG_COPYRIGHT_NOTICE = 116,
IPTC_TAG_PICASA_UNKNOWN = 117,
IPTC_TAG_CONTACT = 118,
IPTC_TAG_CAPTION = 120,
IPTC_TAG_WRITER_EDITOR = 122,
IPTC_TAG_RASTERIZED_CAPTION = 125,
IPTC_TAG_IMAGE_TYPE = 130,
IPTC_TAG_IMAGE_ORIENTATION = 131,
IPTC_TAG_LANGUAGE_ID = 135,
IPTC_TAG_AUDIO_TYPE = 150,
IPTC_TAG_AUDIO_SAMPLING_RATE = 151,
IPTC_TAG_AUDIO_SAMPLING_RES = 152,
IPTC_TAG_AUDIO_DURATION = 153,
IPTC_TAG_AUDIO_OUTCUE = 154,
IPTC_TAG_PREVIEW_FORMAT = 200,
IPTC_TAG_PREVIEW_FORMAT_VER = 201,
IPTC_TAG_PREVIEW_DATA = 202, /* End record 2 tags */
IPTC_TAG_SIZE_MODE = 10, /* Begin record 7 tags */
IPTC_TAG_MAX_SUBFILE_SIZE = 20,
IPTC_TAG_SIZE_ANNOUNCED = 90,
IPTC_TAG_MAX_OBJECT_SIZE = 95, /* End record 7 tags */
IPTC_TAG_SUBFILE = 10, /* Record 8 tags */
IPTC_TAG_CONFIRMED_DATA_SIZE = 10 /* Record 9 tags */
} IptcTag;
</pre>
<p>
The tag number that, together with the record number (<a class="link" href="libiptcdata-tag.html#IptcRecord"><span class="type">IptcRecord</span></a>),
uniquely identifies the purpose of a tag.
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2617078"></a><h3>
<a name="IptcTagInfo"></a>IptcTagInfo</h3>
<a class="indexterm" name="id2592735"></a><pre class="programlisting">typedef struct {
IptcRecord record;
IptcTag tag;
const char *name;
const char *title;
const char *description;
IptcFormat format;
IptcMandatory mandatory;
IptcRepeatable repeatable;
unsigned int minbytes;
unsigned int maxbytes;
} IptcTagInfo;
</pre>
<p>
Contains static information about a specific tag (identified by its
record-tag pair) from the IPTC IIM specificiation. This info is for
reference only and should never be modified by an application.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><a class="link" href="libiptcdata-tag.html#IptcRecord">IptcRecord</a> <em class="structfield"><code>record</code></em>;</span></p></td>
<td>record number of the tag
</td>
</tr>
<tr>
<td><p><span class="term"><a class="link" href="libiptcdata-tag.html#IptcTag">IptcTag</a> <em class="structfield"><code>tag</code></em>;</span></p></td>
<td>dataset number of the tag
</td>
</tr>
<tr>
<td><p><span class="term">const char *<em class="structfield"><code>name</code></em>;</span></p></td>
<td>English name of the tag (no spaces)
</td>
</tr>
<tr>
<td><p><span class="term">const char *<em class="structfield"><code>title</code></em>;</span></p></td>
<td>English title of the tag (may contain spaces)
</td>
</tr>
<tr>
<td><p><span class="term">const char *<em class="structfield"><code>description</code></em>;</span></p></td>
<td>English description of the tag
</td>
</tr>
<tr>
<td><p><span class="term"><a class="link" href="libiptcdata-tag.html#IptcFormat">IptcFormat</a> <em class="structfield"><code>format</code></em>;</span></p></td>
<td>data format of the tag
</td>
</tr>
<tr>
<td><p><span class="term"><a class="link" href="libiptcdata-tag.html#IptcMandatory">IptcMandatory</a> <em class="structfield"><code>mandatory</code></em>;</span></p></td>
<td>whether the specification says the tag
is required
</td>
</tr>
<tr>
<td><p><span class="term"><a class="link" href="libiptcdata-tag.html#IptcRepeatable">IptcRepeatable</a> <em class="structfield"><code>repeatable</code></em>;</span></p></td>
<td>whether the specification says the tag
can appear more than once
</td>
</tr>
<tr>
<td><p><span class="term">unsigned int <em class="structfield"><code>minbytes</code></em>;</span></p></td>
<td>minimum number of bytes in the tag value
</td>
</tr>
<tr>
<td><p><span class="term">unsigned int <em class="structfield"><code>maxbytes</code></em>;</span></p></td>
<td>maximum number of bytes in the tag value
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2621115"></a><h3>
<a name="IptcFormat"></a>enum IptcFormat</h3>
<a class="indexterm" name="id2621127"></a><pre class="programlisting">typedef enum {
IPTC_FORMAT_UNKNOWN,
IPTC_FORMAT_BINARY,
IPTC_FORMAT_BYTE,
IPTC_FORMAT_SHORT,
IPTC_FORMAT_LONG,
IPTC_FORMAT_STRING,
IPTC_FORMAT_NUMERIC_STRING,
IPTC_FORMAT_DATE,
IPTC_FORMAT_TIME
} IptcFormat;
</pre>
<p>
The possible data formats for a tag's value, derived from the IPTC IIM
specification. Integer formats are always represented with the most
significant byte first (big-endian) in the IPTC bytestream.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><a name="IPTC-FORMAT-UNKNOWN:CAPS"></a><code class="literal">IPTC_FORMAT_UNKNOWN</code></span></p></td>
<td>Unknown format (for a tag not in the specification)
</td>
</tr>
<tr>
<td><p><span class="term"><a name="IPTC-FORMAT-BINARY:CAPS"></a><code class="literal">IPTC_FORMAT_BINARY</code></span></p></td>
<td>Binary data (variable length)
</td>
</tr>
<tr>
<td><p><span class="term"><a name="IPTC-FORMAT-BYTE:CAPS"></a><code class="literal">IPTC_FORMAT_BYTE</code></span></p></td>
<td>1-byte integer
</td>
</tr>
<tr>
<td><p><span class="term"><a name="IPTC-FORMAT-SHORT:CAPS"></a><code class="literal">IPTC_FORMAT_SHORT</code></span></p></td>
<td>2-byte integer (big-endian)
</td>
</tr>
<tr>
<td><p><span class="term"><a name="IPTC-FORMAT-LONG:CAPS"></a><code class="literal">IPTC_FORMAT_LONG</code></span></p></td>
<td>4-byte integer (big-endian)
</td>
</tr>
<tr>
<td><p><span class="term"><a name="IPTC-FORMAT-STRING:CAPS"></a><code class="literal">IPTC_FORMAT_STRING</code></span></p></td>
<td>String data (variable length, of any character set)
</td>
</tr>
<tr>
<td><p><span class="term"><a name="IPTC-FORMAT-NUMERIC-STRING:CAPS"></a><code class="literal">IPTC_FORMAT_NUMERIC_STRING</code></span></p></td>
<td>String containing only numerals (variable length)
</td>
</tr>
<tr>
<td><p><span class="term"><a name="IPTC-FORMAT-DATE:CAPS"></a><code class="literal">IPTC_FORMAT_DATE</code></span></p></td>
<td>String of the format "YYYYMMDD" (8 bytes)
</td>
</tr>
<tr>
<td><p><span class="term"><a name="IPTC-FORMAT-TIME:CAPS"></a><code class="literal">IPTC_FORMAT_TIME</code></span></p></td>
<td>String of the format "HHMMSS±HHMM" where the second
HHMM defines the timezone offset (11 bytes)
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2626676"></a><h3>
<a name="IptcMandatory"></a>enum IptcMandatory</h3>
<a class="indexterm" name="id2626686"></a><pre class="programlisting">typedef enum {
IPTC_OPTIONAL = 0,
IPTC_MANDATORY = 1
} IptcMandatory;
</pre>
<p>
Whether a tag is mandatory according to the IPTC IIM specification.
Note that most applications ignore this aspect of the specification
since the spec was designed to encapsulate the media file rather than
the other way around (which is how nearly all applications use it).
This renders most mandatory tags unnecessary.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><a name="IPTC-OPTIONAL:CAPS"></a><code class="literal">IPTC_OPTIONAL</code></span></p></td>
<td>tag is allowed to be absent
</td>
</tr>
<tr>
<td><p><span class="term"><a name="IPTC-MANDATORY:CAPS"></a><code class="literal">IPTC_MANDATORY</code></span></p></td>
<td>tag must be present
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2626748"></a><h3>
<a name="IptcRepeatable"></a>enum IptcRepeatable</h3>
<a class="indexterm" name="id2626759"></a><pre class="programlisting">typedef enum {
IPTC_NOT_REPEATABLE = 0,
IPTC_REPEATABLE = 1
} IptcRepeatable;
</pre>
<p>
Whether a tag can occur more than once according to the IPTC IIM
specification. For example, the "Keywords" tag only contains a single
keyword, but the tag itself is repeated for media that references more
than one keyword.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><a name="IPTC-NOT-REPEATABLE:CAPS"></a><code class="literal">IPTC_NOT_REPEATABLE</code></span></p></td>
<td>tag can only appear once
</td>
</tr>
<tr>
<td><p><span class="term"><a name="IPTC-REPEATABLE:CAPS"></a><code class="literal">IPTC_REPEATABLE</code></span></p></td>
<td>tag can be repeated
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2626819"></a><h3>
<a name="iptc-tag-get-name"></a>iptc_tag_get_name ()</h3>
<a class="indexterm" name="id2626830"></a><pre class="programlisting">const char* iptc_tag_get_name (<a class="link" href="libiptcdata-tag.html#IptcRecord">IptcRecord</a> record,
<a class="link" href="libiptcdata-tag.html#IptcTag">IptcTag</a> tag);</pre>
<p>
Retrieves the name of a tag. The name is derived from the IPTC
IIM specification and gives an indication of the purpose of a
particular tag. The name will consist of ASCII characters with
no spaces, for example "CopyrightNotice".</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>record</code></em> :</span></p></td>
<td> record number of tag
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>tag</code></em> :</span></p></td>
<td> dataset number of tag
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a static string containing the tag name, NULL if none found
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2626909"></a><h3>
<a name="iptc-tag-get-title"></a>iptc_tag_get_title ()</h3>
<a class="indexterm" name="id2626919"></a><pre class="programlisting">char* iptc_tag_get_title (<a class="link" href="libiptcdata-tag.html#IptcRecord">IptcRecord</a> record,
<a class="link" href="libiptcdata-tag.html#IptcTag">IptcTag</a> tag);</pre>
<p>
Retrieves the title of a tag. The title is similar to
the name, except it will be translated to the current
locale (if available) and may contain spaces, for example
"Copyright Notice". It is appropriate for the title to appear
in user interfaces. The return value will be encoding using the UTF-8
character set.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>record</code></em> :</span></p></td>
<td> record number of tag
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>tag</code></em> :</span></p></td>
<td> dataset number of tag
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a static string containing the tag title, empty string
if none found
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2626998"></a><h3>
<a name="iptc-tag-get-description"></a>iptc_tag_get_description ()</h3>
<a class="indexterm" name="id2627009"></a><pre class="programlisting">char* iptc_tag_get_description (<a class="link" href="libiptcdata-tag.html#IptcRecord">IptcRecord</a> record,
<a class="link" href="libiptcdata-tag.html#IptcTag">IptcTag</a> tag);</pre>
<p>
Retrieves the description of a tag, which explains the purpose
of the tag from the IPTC IIM specification. It is translated
to the current locale if available. The return value will
be encoded using the UTF-8 character set.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>record</code></em> :</span></p></td>
<td> record number of tag
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>tag</code></em> :</span></p></td>
<td> dataset number of tag
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a static string containing the tag desciption, empty
string if none found
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2627087"></a><h3>
<a name="iptc-tag-get-info"></a>iptc_tag_get_info ()</h3>
<a class="indexterm" name="id2627097"></a><pre class="programlisting">const <a class="link" href="libiptcdata-tag.html#IptcTagInfo">IptcTagInfo</a>* iptc_tag_get_info (<a class="link" href="libiptcdata-tag.html#IptcRecord">IptcRecord</a> record,
<a class="link" href="libiptcdata-tag.html#IptcTag">IptcTag</a> tag);</pre>
<p>
Retrieves the <a class="link" href="libiptcdata-tag.html#IptcTagInfo"><span class="type">IptcTagInfo</span></a> structure containing information about the
tag from the IPTC IIM specification such as purpose, data format,
and minimum and maximum lengths.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>record</code></em> :</span></p></td>
<td> record number of tag
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>tag</code></em> :</span></p></td>
<td> dataset number of tag
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a pointer to a static <a class="link" href="libiptcdata-tag.html#IptcTagInfo"><span class="type">IptcTagInfo</span></a> structure or NULL if
the tag is not found.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2627186"></a><h3>
<a name="iptc-format-get-name"></a>iptc_format_get_name ()</h3>
<a class="indexterm" name="id2627196"></a><pre class="programlisting">char* iptc_format_get_name (<a class="link" href="libiptcdata-tag.html#IptcFormat">IptcFormat</a> format);</pre>
<p>
Retrieves a string version of a data format. For example,
<a class="link" href="libiptcdata-tag.html#IPTC-FORMAT-STRING:CAPS"><code class="literal">IPTC_FORMAT_STRING</code></a> returns "String".</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
<td> the format to be retrieved
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a static string in the native locale
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2627259"></a><h3>
<a name="iptc-tag-find-by-name"></a>iptc_tag_find_by_name ()</h3>
<a class="indexterm" name="id2627270"></a><pre class="programlisting">int iptc_tag_find_by_name (const char *name,
<a class="link" href="libiptcdata-tag.html#IptcRecord">IptcRecord</a> *record,
<a class="link" href="libiptcdata-tag.html#IptcTag">IptcTag</a> *tag);</pre>
<p>
Looks up the record and tag numbers for a tag specified by name. For
example, searching for "Caption" would return 2:120 in the record and
tag variables.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td> the name to search for
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>record</code></em> :</span></p></td>
<td> output variable to store the record number
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>tag</code></em> :</span></p></td>
<td> output variable to store the tag number
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> 0 on success, -1 on failure or if the tag name was not found
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2627368"></a><div class="refsect2" lang="en"><a name="id2627369"></a></div>
<hr>
<div class="refsect2" lang="en"><a name="id2627370"></a></div>
</div>
</div>
</body>
</html>
|
