libiptcdata-doc 1.0.4-4ubuntu1 / usr / share / gtk-doc / html / libiptcdata / libiptcdata-dataset.html

This file is indexed.

/usr/share/gtk-doc/html/libiptcdata/libiptcdata-dataset.html is in libiptcdata-doc 1.0.4-4ubuntu1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

   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
 684
 685
 686
 687
 688
 689
 690
 691
 692
 693
 694
 695
 696
 697
 698
 699
 700
 701
 702
 703
 704
 705
 706
 707
 708
 709
 710
 711
 712
 713
 714
 715
 716
 717
 718
 719
 720
 721
 722
 723
 724
 725
 726
 727
 728
 729
 730
 731
 732
 733
 734
 735
 736
 737
 738
 739
 740
 741
 742
 743
 744
 745
 746
 747
 748
 749
 750
 751
 752
 753
 754
 755
 756
 757
 758
 759
 760
 761
 762
 763
 764
 765
 766
 767
 768
 769
 770
 771
 772
 773
 774
 775
 776
 777
 778
 779
 780
 781
 782
 783
 784
 785
 786
 787
 788
 789
 790
 791
 792
 793
 794
 795
 796
 797
 798
 799
 800
 801
 802
 803
 804
 805
 806
 807
 808
 809
 810
 811
 812
 813
 814
 815
 816
 817
 818
 819
 820
 821
 822
 823
 824
 825
 826
 827
 828
 829
 830
 831
 832
 833
 834
 835
 836
 837
 838
 839
 840
 841
 842
 843
 844
 845
 846
 847
 848
 849
 850
 851
 852
 853
 854
 855
 856
 857
 858
 859
 860
 861
 862
 863
 864
 865
 866
 867
 868
 869
 870
 871
 872
 873
 874
 875
 876
 877
 878
 879
 880
 881
 882
 883
 884
 885
 886
 887
 888
 889
 890
 891
 892
 893
 894
 895
 896
 897
 898
 899
 900
 901
 902
 903
 904
 905
 906
 907
 908
 909
 910
 911
 912
 913
 914
 915
 916
 917
 918
 919
 920
 921
 922
 923
 924
 925
 926
 927
 928
 929
 930
 931
 932
 933
 934
 935
 936
 937
 938
 939
 940
 941
 942
 943
 944
 945
 946
 947
 948
 949
 950
 951
 952
 953
 954
 955
 956
 957
 958
 959
 960
 961
 962
 963
 964
 965
 966
 967
 968
 969
 970
 971
 972
 973
 974
 975
 976
 977
 978
 979
 980
 981
 982
 983
 984
 985
 986
 987
 988
 989
 990
 991
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>libiptcdata Reference Manual: Datasets</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="libiptcdata Reference Manual">
<link rel="up" href="ch01.html" title="IPTC Data Manipulation">
<link rel="prev" href="libiptcdata-data.html" title="IPTC Data">
<link rel="next" href="libiptcdata-tag.html" title="Tag Specifications">
<meta name="generator" content="GTK-Doc V1.20 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> 
                  <a href="#libiptcdata-dataset.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 
                  <a href="#libiptcdata-dataset.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libiptcdata-data.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libiptcdata-tag.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libiptcdata-dataset"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libiptcdata-dataset.top_of_page"></a>Datasets</span></h2>
<p>Datasets — manipulating a tag identifier and its associated value</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libiptcdata-dataset.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="libiptcdata-dataset.html#IptcDataSet" title="struct IptcDataSet"><span class="returnvalue">IptcDataSet</span></a> *
</td>
<td class="function_name">
<a class="link" href="libiptcdata-dataset.html#iptc-dataset-new" title="iptc_dataset_new ()">iptc_dataset_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="libiptcdata-dataset.html#IptcDataSet" title="struct IptcDataSet"><span class="returnvalue">IptcDataSet</span></a> *
</td>
<td class="function_name">
<a class="link" href="libiptcdata-dataset.html#iptc-dataset-new-mem" title="iptc_dataset_new_mem ()">iptc_dataset_new_mem</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="libiptcdata-dataset.html#IptcDataSet" title="struct IptcDataSet"><span class="returnvalue">IptcDataSet</span></a> *
</td>
<td class="function_name">
<a class="link" href="libiptcdata-dataset.html#iptc-dataset-copy" title="iptc_dataset_copy ()">iptc_dataset_copy</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libiptcdata-dataset.html#iptc-dataset-ref" title="iptc_dataset_ref ()">iptc_dataset_ref</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libiptcdata-dataset.html#iptc-dataset-unref" title="iptc_dataset_unref ()">iptc_dataset_unref</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libiptcdata-dataset.html#iptc-dataset-free" title="iptc_dataset_free ()">iptc_dataset_free</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="libiptcdata-tag.html#IptcFormat" title="enum IptcFormat"><span class="returnvalue">IptcFormat</span></a>
</td>
<td class="function_name">
<a class="link" href="libiptcdata-dataset.html#iptc-dataset-get-format" title="iptc_dataset_get_format ()">iptc_dataset_get_format</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="libiptcdata-dataset.html#iptc-dataset-get-data" title="iptc_dataset_get_data ()">iptc_dataset_get_data</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">unsigned <span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="libiptcdata-dataset.html#iptc-dataset-get-value" title="iptc_dataset_get_value ()">iptc_dataset_get_value</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="libiptcdata-dataset.html#iptc-dataset-get-date" title="iptc_dataset_get_date ()">iptc_dataset_get_date</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="libiptcdata-dataset.html#iptc-dataset-get-time" title="iptc_dataset_get_time ()">iptc_dataset_get_time</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libiptcdata-dataset.html#iptc-dataset-set-tag" title="iptc_dataset_set_tag ()">iptc_dataset_set_tag</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="libiptcdata-dataset.html#iptc-dataset-set-data" title="iptc_dataset_set_data ()">iptc_dataset_set_data</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="libiptcdata-dataset.html#iptc-dataset-set-value" title="iptc_dataset_set_value ()">iptc_dataset_set_value</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="libiptcdata-dataset.html#iptc-dataset-set-date" title="iptc_dataset_set_date ()">iptc_dataset_set_date</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="libiptcdata-dataset.html#iptc-dataset-set-time" title="iptc_dataset_set_time ()">iptc_dataset_set_time</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">char</span> *
</td>
<td class="function_name">
<a class="link" href="libiptcdata-dataset.html#iptc-dataset-get-as-str" title="iptc_dataset_get_as_str ()">iptc_dataset_get_as_str</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libiptcdata-dataset.html#iptc-dataset-dump" title="iptc_dataset_dump ()">iptc_dataset_dump</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libiptcdata-dataset.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="libiptcdata-dataset.html#IptcDataSet" title="struct IptcDataSet">IptcDataSet</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="libiptcdata-dataset.html#IptcValidate" title="enum IptcValidate">IptcValidate</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libiptcdata-dataset.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">
</pre>
</div>
<div class="refsect1">
<a name="libiptcdata-dataset.description"></a><h2>Description</h2>
<p>
The <a class="link" href="libiptcdata-dataset.html#IptcDataSet" title="struct IptcDataSet"><span class="type">IptcDataSet</span></a> 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.
</p>
</div>
<div class="refsect1">
<a name="libiptcdata-dataset.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="iptc-dataset-new"></a><h3>iptc_dataset_new ()</h3>
<pre class="programlisting"><a class="link" href="libiptcdata-dataset.html#IptcDataSet" title="struct IptcDataSet"><span class="returnvalue">IptcDataSet</span></a> *
iptc_dataset_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>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
<a class="link" href="libiptcdata-dataset.html#iptc-dataset-new-mem" title="iptc_dataset_new_mem ()"><code class="function">iptc_dataset_new_mem()</code></a> instead.  This allocation will set the <a class="link" href="libiptcdata-dataset.html#IptcDataSet" title="struct IptcDataSet"><span class="type">IptcDataSet</span></a>
refcount to 1, so use <a class="link" href="libiptcdata-dataset.html#iptc-dataset-unref" title="iptc_dataset_unref ()"><code class="function">iptc_dataset_unref()</code></a> when finished with the pointer.</p>
<div class="refsect3">
<a name="id-1.7.3.7.2.5"></a><h4>Returns</h4>
<p> pointer to the new <a class="link" href="libiptcdata-dataset.html#IptcDataSet" title="struct IptcDataSet"><span class="type">IptcDataSet</span></a> object, NULL on error</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="iptc-dataset-new-mem"></a><h3>iptc_dataset_new_mem ()</h3>
<pre class="programlisting"><a class="link" href="libiptcdata-dataset.html#IptcDataSet" title="struct IptcDataSet"><span class="returnvalue">IptcDataSet</span></a> *
iptc_dataset_new_mem (<em class="parameter"><code><a class="link" href="libiptcdata-mem.html#IptcMem" title="IptcMem"><span class="type">IptcMem</span></a> *mem</code></em>);</pre>
<p>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 <a class="link" href="libiptcdata-dataset.html#IptcDataSet" title="struct IptcDataSet"><span class="type">IptcDataSet</span></a> refcount to 1, so use <a class="link" href="libiptcdata-dataset.html#iptc-dataset-unref" title="iptc_dataset_unref ()"><code class="function">iptc_dataset_unref()</code></a> when
finished with the pointer.</p>
<div class="refsect3">
<a name="id-1.7.3.7.3.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>mem</p></td>
<td class="parameter_description"><p>Pointer to an <a class="link" href="libiptcdata-mem.html#IptcMem" title="IptcMem"><span class="type">IptcMem</span></a> object that defines custom memory managment
functions.  The refcount of <em class="parameter"><code>mem</code></em>
will be incremented.  It is decremented
when the returned <a class="link" href="libiptcdata-dataset.html#IptcDataSet" title="struct IptcDataSet"><span class="type">IptcDataSet</span></a> object is freed.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.7.3.7.3.6"></a><h4>Returns</h4>
<p> pointer to the new <a class="link" href="libiptcdata-dataset.html#IptcDataSet" title="struct IptcDataSet"><span class="type">IptcDataSet</span></a> object, NULL on error</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="iptc-dataset-copy"></a><h3>iptc_dataset_copy ()</h3>
<pre class="programlisting"><a class="link" href="libiptcdata-dataset.html#IptcDataSet" title="struct IptcDataSet"><span class="returnvalue">IptcDataSet</span></a> *
iptc_dataset_copy (<em class="parameter"><code><a class="link" href="libiptcdata-dataset.html#IptcDataSet" title="struct IptcDataSet"><span class="type">IptcDataSet</span></a> *dataset</code></em>);</pre>
<p>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 <a class="link" href="libiptcdata-dataset.html#IptcDataSet" title="struct IptcDataSet"><span class="type">IptcDataSet</span></a> refcount to 1, so use <a class="link" href="libiptcdata-dataset.html#iptc-dataset-unref" title="iptc_dataset_unref ()"><code class="function">iptc_dataset_unref()</code></a> when finished
with the pointer.</p>
<div class="refsect3">
<a name="id-1.7.3.7.4.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>dataset</p></td>
<td class="parameter_description"><p>the dataset to duplicate</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.7.3.7.4.6"></a><h4>Returns</h4>
<p> pointer to the new <a class="link" href="libiptcdata-dataset.html#IptcDataSet" title="struct IptcDataSet"><span class="type">IptcDataSet</span></a> object, NULL on error</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="iptc-dataset-ref"></a><h3>iptc_dataset_ref ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
iptc_dataset_ref (<em class="parameter"><code><a class="link" href="libiptcdata-dataset.html#IptcDataSet" title="struct IptcDataSet"><span class="type">IptcDataSet</span></a> *dataset</code></em>);</pre>
<p>Increments the reference count of an <a class="link" href="libiptcdata-dataset.html#IptcDataSet" title="struct IptcDataSet"><span class="type">IptcDataSet</span></a> object.  This function
should be called whenever a copy of a pointer is made by the application.
<a class="link" href="libiptcdata-dataset.html#iptc-dataset-unref" title="iptc_dataset_unref ()"><code class="function">iptc_dataset_unref()</code></a> can then be used when the pointer is no longer needed
to ensure that the object is freed once the object is completely unused.</p>
<div class="refsect3">
<a name="id-1.7.3.7.5.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>dataset</p></td>
<td class="parameter_description"><p>the referenced pointer</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="iptc-dataset-unref"></a><h3>iptc_dataset_unref ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
iptc_dataset_unref (<em class="parameter"><code><a class="link" href="libiptcdata-dataset.html#IptcDataSet" title="struct IptcDataSet"><span class="type">IptcDataSet</span></a> *dataset</code></em>);</pre>
<p>Decrements the reference count of an <a class="link" href="libiptcdata-dataset.html#IptcDataSet" title="struct IptcDataSet"><span class="type">IptcDataSet</span></a> 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.</p>
<div class="refsect3">
<a name="id-1.7.3.7.6.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>dataset</p></td>
<td class="parameter_description"><p>the unreferenced pointer</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="iptc-dataset-free"></a><h3>iptc_dataset_free ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
iptc_dataset_free (<em class="parameter"><code><a class="link" href="libiptcdata-dataset.html#IptcDataSet" title="struct IptcDataSet"><span class="type">IptcDataSet</span></a> *dataset</code></em>);</pre>
<p>Frees an <a class="link" href="libiptcdata-dataset.html#IptcDataSet" title="struct IptcDataSet"><span class="type">IptcDataSet</span></a> object and its contained data.  This function should
be used only for error handling since <a class="link" href="libiptcdata-dataset.html#iptc-dataset-unref" title="iptc_dataset_unref ()"><code class="function">iptc_dataset_unref()</code></a> provides a
safer mechanism for freeing that allows multiple components to have access
to an object.</p>
<div class="refsect3">
<a name="id-1.7.3.7.7.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>dataset</p></td>
<td class="parameter_description"><p>the object to free</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="iptc-dataset-get-format"></a><h3>iptc_dataset_get_format ()</h3>
<pre class="programlisting"><a class="link" href="libiptcdata-tag.html#IptcFormat" title="enum IptcFormat"><span class="returnvalue">IptcFormat</span></a>
iptc_dataset_get_format (<em class="parameter"><code><a class="link" href="libiptcdata-dataset.html#IptcDataSet" title="struct IptcDataSet"><span class="type">IptcDataSet</span></a> *dataset</code></em>);</pre>
<p>Retrieves the data format of a dataset tag according to the IPTC
specification.</p>
<div class="refsect3">
<a name="id-1.7.3.7.8.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>dataset</p></td>
<td class="parameter_description"><p>pointer to an <a class="link" href="libiptcdata-dataset.html#IptcDataSet" title="struct IptcDataSet"><span class="type">IptcDataSet</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.7.3.7.8.6"></a><h4>Returns</h4>
<p> the format of the tag which will be <a class="link" href="libiptcdata-tag.html#IPTC-FORMAT-UNKNOWN:CAPS"><code class="literal">IPTC_FORMAT_UNKNOWN</code></a> if the tag
number has not been set or the tag is not in the specification</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="iptc-dataset-get-data"></a><h3>iptc_dataset_get_data ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
iptc_dataset_get_data (<em class="parameter"><code><a class="link" href="libiptcdata-dataset.html#IptcDataSet" title="struct IptcDataSet"><span class="type">IptcDataSet</span></a> *dataset</code></em>,
                       <em class="parameter"><code>unsigned <span class="type">char</span> *buf</code></em>,
                       <em class="parameter"><code>unsigned <span class="type">int</span> size</code></em>);</pre>
<p>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.</p>
<div class="refsect3">
<a name="id-1.7.3.7.9.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>dataset</p></td>
<td class="parameter_description"><p>pointer to an <a class="link" href="libiptcdata-dataset.html#IptcDataSet" title="struct IptcDataSet"><span class="type">IptcDataSet</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>buf</p></td>
<td class="parameter_description"><p>buffer to which the data will be copied</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>size</p></td>
<td class="parameter_description"><p>maximum size of the buffer</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.7.3.7.9.6"></a><h4>Returns</h4>
<p> the number of bytes copied, or -1 on failure</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="iptc-dataset-get-value"></a><h3>iptc_dataset_get_value ()</h3>
<pre class="programlisting">unsigned <span class="returnvalue">int</span>
iptc_dataset_get_value (<em class="parameter"><code><a class="link" href="libiptcdata-dataset.html#IptcDataSet" title="struct IptcDataSet"><span class="type">IptcDataSet</span></a> *dataset</code></em>);</pre>
<p>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.</p>
<div class="refsect3">
<a name="id-1.7.3.7.10.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>dataset</p></td>
<td class="parameter_description"><p>pointer to an <a class="link" href="libiptcdata-dataset.html#IptcDataSet" title="struct IptcDataSet"><span class="type">IptcDataSet</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.7.3.7.10.6"></a><h4>Returns</h4>
<p> value contained in the dataset</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="iptc-dataset-get-date"></a><h3>iptc_dataset_get_date ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
iptc_dataset_get_date (<em class="parameter"><code><a class="link" href="libiptcdata-dataset.html#IptcDataSet" title="struct IptcDataSet"><span class="type">IptcDataSet</span></a> *dataset</code></em>,
                       <em class="parameter"><code><span class="type">int</span> *year</code></em>,
                       <em class="parameter"><code><span class="type">int</span> *month</code></em>,
                       <em class="parameter"><code><span class="type">int</span> *day</code></em>);</pre>
<p>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.</p>
<div class="refsect3">
<a name="id-1.7.3.7.11.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>dataset</p></td>
<td class="parameter_description"><p>pointer to an <a class="link" href="libiptcdata-dataset.html#IptcDataSet" title="struct IptcDataSet"><span class="type">IptcDataSet</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>year</p></td>
<td class="parameter_description"><p>output variable to store the year (0-9999)</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>month</p></td>
<td class="parameter_description"><p>output variable to store the month (1-12)</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>day</p></td>
<td class="parameter_description"><p>output variable to store the day of the month (1-31)</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.7.3.7.11.6"></a><h4>Returns</h4>
<p> 0 on success; -1 on failure</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="iptc-dataset-get-time"></a><h3>iptc_dataset_get_time ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
iptc_dataset_get_time (<em class="parameter"><code><a class="link" href="libiptcdata-dataset.html#IptcDataSet" title="struct IptcDataSet"><span class="type">IptcDataSet</span></a> *dataset</code></em>,
                       <em class="parameter"><code><span class="type">int</span> *hour</code></em>,
                       <em class="parameter"><code><span class="type">int</span> *min</code></em>,
                       <em class="parameter"><code><span class="type">int</span> *sec</code></em>,
                       <em class="parameter"><code><span class="type">int</span> *tz</code></em>);</pre>
<p>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.</p>
<div class="refsect3">
<a name="id-1.7.3.7.12.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>dataset</p></td>
<td class="parameter_description"><p>pointer to an <a class="link" href="libiptcdata-dataset.html#IptcDataSet" title="struct IptcDataSet"><span class="type">IptcDataSet</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>hour</p></td>
<td class="parameter_description"><p>output variable to store the hour (0-23)</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>min</p></td>
<td class="parameter_description"><p>output variable to store the minute (0-59)</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>sec</p></td>
<td class="parameter_description"><p>output variable to store the second (0-59)</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>tz</p></td>
<td class="parameter_description"><p>output variable to store the timezone (offset in minutes from GMT)</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.7.3.7.12.6"></a><h4>Returns</h4>
<p> 0 on success; -1 on failure</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="iptc-dataset-set-tag"></a><h3>iptc_dataset_set_tag ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
iptc_dataset_set_tag (<em class="parameter"><code><a class="link" href="libiptcdata-dataset.html#IptcDataSet" title="struct IptcDataSet"><span class="type">IptcDataSet</span></a> *dataset</code></em>,
                      <em class="parameter"><code><a class="link" href="libiptcdata-tag.html#IptcRecord" title="enum IptcRecord"><span class="type">IptcRecord</span></a> record</code></em>,
                      <em class="parameter"><code><a class="link" href="libiptcdata-tag.html#IptcTag" title="enum IptcTag"><span class="type">IptcTag</span></a> tag</code></em>);</pre>
<p>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.</p>
<div class="refsect3">
<a name="id-1.7.3.7.13.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>dataset</p></td>
<td class="parameter_description"><p>dataset for which the record/tag numbers should be set</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>record</p></td>
<td class="parameter_description"><p>record number of the dataset</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>tag</p></td>
<td class="parameter_description"><p>tag (dataset number) of the dataset</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="iptc-dataset-set-data"></a><h3>iptc_dataset_set_data ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
iptc_dataset_set_data (<em class="parameter"><code><a class="link" href="libiptcdata-dataset.html#IptcDataSet" title="struct IptcDataSet"><span class="type">IptcDataSet</span></a> *dataset</code></em>,
                       <em class="parameter"><code>const unsigned <span class="type">char</span> *buf</code></em>,
                       <em class="parameter"><code>unsigned <span class="type">int</span> size</code></em>,
                       <em class="parameter"><code><a class="link" href="libiptcdata-dataset.html#IptcValidate" title="enum IptcValidate"><span class="type">IptcValidate</span></a> validate</code></em>);</pre>
<p>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 <em class="parameter"><code>size</code></em>
 bytes are copied
from <em class="parameter"><code>buf</code></em>
 into this new memory (which is freed when the dataset is freed or
when a new value is set).  If <em class="parameter"><code>validate</code></em>
 is set to <a class="link" href="libiptcdata-dataset.html#IPTC-VALIDATE:CAPS"><code class="literal">IPTC_VALIDATE</code></a>, 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.</p>
<div class="refsect3">
<a name="id-1.7.3.7.14.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>dataset</p></td>
<td class="parameter_description"><p>dataset for which the value should be set</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>buf</p></td>
<td class="parameter_description"><p>buffer containing the value</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>size</p></td>
<td class="parameter_description"><p>number of bytes to copy</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>validate</p></td>
<td class="parameter_description"><p>whether or not the passed value should be validated against
the IPTC specification for this dataset's tag.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.7.3.7.14.6"></a><h4>Returns</h4>
<p> -1 on error, 0 if validation failed, the number of bytes copied
on success</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="iptc-dataset-set-value"></a><h3>iptc_dataset_set_value ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
iptc_dataset_set_value (<em class="parameter"><code><a class="link" href="libiptcdata-dataset.html#IptcDataSet" title="struct IptcDataSet"><span class="type">IptcDataSet</span></a> *dataset</code></em>,
                        <em class="parameter"><code>unsigned <span class="type">int</span> value</code></em>,
                        <em class="parameter"><code><a class="link" href="libiptcdata-dataset.html#IptcValidate" title="enum IptcValidate"><span class="type">IptcValidate</span></a> validate</code></em>);</pre>
<p>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 <em class="parameter"><code>validate</code></em>
 is
set to <a class="link" href="libiptcdata-dataset.html#IPTC-VALIDATE:CAPS"><code class="literal">IPTC_VALIDATE</code></a>, 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.</p>
<div class="refsect3">
<a name="id-1.7.3.7.15.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>dataset</p></td>
<td class="parameter_description"><p>dataset for which the value should be set</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>value</p></td>
<td class="parameter_description"><p>value for the dataset</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>validate</p></td>
<td class="parameter_description"><p>whether or not the passed value should be validated against
the IPTC specification for this dataset's tag.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.7.3.7.15.6"></a><h4>Returns</h4>
<p> -1 on error, 0 if validation failed, the number of bytes copied
on success</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="iptc-dataset-set-date"></a><h3>iptc_dataset_set_date ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
iptc_dataset_set_date (<em class="parameter"><code><a class="link" href="libiptcdata-dataset.html#IptcDataSet" title="struct IptcDataSet"><span class="type">IptcDataSet</span></a> *dataset</code></em>,
                       <em class="parameter"><code><span class="type">int</span> year</code></em>,
                       <em class="parameter"><code><span class="type">int</span> month</code></em>,
                       <em class="parameter"><code><span class="type">int</span> day</code></em>,
                       <em class="parameter"><code><a class="link" href="libiptcdata-dataset.html#IptcValidate" title="enum IptcValidate"><span class="type">IptcValidate</span></a> validate</code></em>);</pre>
<p>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.</p>
<div class="refsect3">
<a name="id-1.7.3.7.16.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>dataset</p></td>
<td class="parameter_description"><p>pointer to an <a class="link" href="libiptcdata-dataset.html#IptcDataSet" title="struct IptcDataSet"><span class="type">IptcDataSet</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>year</p></td>
<td class="parameter_description"><p>the year (0-9999)</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>month</p></td>
<td class="parameter_description"><p>the month (1-12)</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>day</p></td>
<td class="parameter_description"><p>the day of the month (1-31)</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>validate</p></td>
<td class="parameter_description"><p>if set to <a class="link" href="libiptcdata-dataset.html#IPTC-VALIDATE:CAPS"><code class="literal">IPTC_VALIDATE</code></a>, the dataset date will only be set if
the IPTC specification says it is of type date.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.7.3.7.16.6"></a><h4>Returns</h4>
<p> the number of bytes written on success (always 8 in this case); 0
if validation fails; -1 for other failures</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="iptc-dataset-set-time"></a><h3>iptc_dataset_set_time ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
iptc_dataset_set_time (<em class="parameter"><code><a class="link" href="libiptcdata-dataset.html#IptcDataSet" title="struct IptcDataSet"><span class="type">IptcDataSet</span></a> *dataset</code></em>,
                       <em class="parameter"><code><span class="type">int</span> hour</code></em>,
                       <em class="parameter"><code><span class="type">int</span> min</code></em>,
                       <em class="parameter"><code><span class="type">int</span> sec</code></em>,
                       <em class="parameter"><code><span class="type">int</span> tz</code></em>,
                       <em class="parameter"><code><a class="link" href="libiptcdata-dataset.html#IptcValidate" title="enum IptcValidate"><span class="type">IptcValidate</span></a> validate</code></em>);</pre>
<p>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.</p>
<div class="refsect3">
<a name="id-1.7.3.7.17.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>dataset</p></td>
<td class="parameter_description"><p>pointer to an <a class="link" href="libiptcdata-dataset.html#IptcDataSet" title="struct IptcDataSet"><span class="type">IptcDataSet</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>hour</p></td>
<td class="parameter_description"><p>the hour (0-23)</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>min</p></td>
<td class="parameter_description"><p>the minutes (0-59)</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>sec</p></td>
<td class="parameter_description"><p>the seconds (0-61)</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>tz</p></td>
<td class="parameter_description"><p>the timezone expressed as the number of minutes offset from GMT.
For example, EST is -300 (-5 hours).</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>validate</p></td>
<td class="parameter_description"><p>if set to <a class="link" href="libiptcdata-dataset.html#IPTC-VALIDATE:CAPS"><code class="literal">IPTC_VALIDATE</code></a>, the dataset time will only be set if
the IPTC specification says it is of type time.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.7.3.7.17.6"></a><h4>Returns</h4>
<p> the number of bytes written on success (always 11 in this case); 0
if validation fails; -1 for other failures</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="iptc-dataset-get-as-str"></a><h3>iptc_dataset_get_as_str ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> *
iptc_dataset_get_as_str (<em class="parameter"><code><a class="link" href="libiptcdata-dataset.html#IptcDataSet" title="struct IptcDataSet"><span class="type">IptcDataSet</span></a> *dataset</code></em>,
                         <em class="parameter"><code><span class="type">char</span> *buf</code></em>,
                         <em class="parameter"><code>unsigned <span class="type">int</span> size</code></em>);</pre>
<p>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.</p>
<div class="refsect3">
<a name="id-1.7.3.7.18.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>dataset</p></td>
<td class="parameter_description"><p>pointer to an <a class="link" href="libiptcdata-dataset.html#IptcDataSet" title="struct IptcDataSet"><span class="type">IptcDataSet</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>buf</p></td>
<td class="parameter_description"><p>buffer to which the string will be copied</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>size</p></td>
<td class="parameter_description"><p>maximum size of the buffer</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.7.3.7.18.6"></a><h4>Returns</h4>
<p> the output string on success, or NULL on failure</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="iptc-dataset-dump"></a><h3>iptc_dataset_dump ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
iptc_dataset_dump (<em class="parameter"><code><a class="link" href="libiptcdata-dataset.html#IptcDataSet" title="struct IptcDataSet"><span class="type">IptcDataSet</span></a> *dataset</code></em>,
                   <em class="parameter"><code>unsigned <span class="type">int</span> indent</code></em>);</pre>
<p>A debugging aid that prints out the contents of a dataset to
standard output.</p>
<div class="refsect3">
<a name="id-1.7.3.7.19.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>dataset</p></td>
<td class="parameter_description"><p>dataset to print</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>indent</p></td>
<td class="parameter_description"><p>indentation level of the printout</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="libiptcdata-dataset.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="IptcDataSet"></a><h3>struct IptcDataSet</h3>
<pre class="programlisting">struct IptcDataSet {
	IptcRecord record;
        IptcTag tag;
        const IptcTagInfo * info;

        unsigned char *data;
        unsigned int size;

	/* Data containing this dataset */
	IptcData *parent;

	IptcDataSetPrivate *priv;
};
</pre>
<p>
An IPTC dataset, which associates a record/tag pair with a value.
</p>
<div class="refsect3">
<a name="id-1.7.3.8.2.5"></a><h4>Members</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p><a class="link" href="libiptcdata-tag.html#IptcRecord" title="enum IptcRecord"><span class="type">IptcRecord</span></a> <em class="structfield"><code><a name="IptcDataSet.record"></a>record</code></em>;</p></td>
<td class="struct_member_description"><p>the record number</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><a class="link" href="libiptcdata-tag.html#IptcTag" title="enum IptcTag"><span class="type">IptcTag</span></a> <em class="structfield"><code><a name="IptcDataSet.tag"></a>tag</code></em>;</p></td>
<td class="struct_member_description"><p>the dataset number</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p>const <a class="link" href="libiptcdata-tag.html#IptcTagInfo" title="struct IptcTagInfo"><span class="type">IptcTagInfo</span></a> *<em class="structfield"><code><a name="IptcDataSet.info"></a>info</code></em>;</p></td>
<td class="struct_member_description"><p>information about the tag from the IPTC IIM specification</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p>unsigned <span class="type">char</span> *<em class="structfield"><code><a name="IptcDataSet.data"></a>data</code></em>;</p></td>
<td class="struct_member_description"><p>the value of the tag</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p>unsigned <span class="type">int</span> <em class="structfield"><code><a name="IptcDataSet.size"></a>size</code></em>;</p></td>
<td class="struct_member_description"><p>the length of <em class="parameter"><code>data</code></em>
in bytes</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><a class="link" href="libiptcdata-data.html#IptcData" title="struct IptcData"><span class="type">IptcData</span></a> *<em class="structfield"><code><a name="IptcDataSet.parent"></a>parent</code></em>;</p></td>
<td class="struct_member_description"><p>the <a class="link" href="libiptcdata-data.html#IptcData" title="struct IptcData"><span class="type">IptcData</span></a> object that contains this dataset or NULL
if it is not contained</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">IptcDataSetPrivate</span> *<em class="structfield"><code><a name="IptcDataSet.priv"></a>priv</code></em>;</p></td>
<td class="struct_member_description"><p>private data</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="IptcValidate"></a><h3>enum IptcValidate</h3>
<p>
Whether the value of a dataset should be validated to meet the IPTC
IIM specification.
</p>
<div class="refsect3">
<a name="id-1.7.3.8.3.4"></a><h4>Members</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="IPTC-DONT-VALIDATE:CAPS"></a>IPTC_DONT_VALIDATE</p></td>
<td class="enum_member_description">
<p>do not check the value against the specification</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="IPTC-VALIDATE:CAPS"></a>IPTC_VALIDATE</p></td>
<td class="enum_member_description">
<p>check the value against the specification</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.20</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.