File: libpff.3

package info (click to toggle)
libpff 20120802-5
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 13,524 kB
  • ctags: 6,784
  • sloc: ansic: 214,206; sh: 11,485; makefile: 1,229; python: 138; java: 137; sed: 16
file content (685 lines) | stat: -rw-r--r-- 43,780 bytes parent folder | download | duplicates (2)
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
.Dd July 29, 2012
.Dt libpff 3
.Os libpff
.Sh NAME
.Nm libpff.h
.Nd Library to access the Personal Folder File (PFF) and the Offline Folder File (OFF) format. PFF is used in PAB (Personal Address Book), PST (Personal Storage Table) and OST (Offline Storage Table) files.
.Sh LIBRARY
.Lb libpff
.Sh SYNOPSIS
.In libpff.h
.Pp
Support functions
.Ft const char *
.Fn libpff_get_version "void"
.Ft int
.Fn libpff_get_access_flags_read
.Ft int
.Fn libpff_get_codepage "int *codepage, libpff_error_t **error"
.Ft int
.Fn libpff_set_codepage "int codepage, libpff_error_t **error"
.Ft int
.Fn libpff_check_file_signature "const char *filename, libpff_error_t **error"
.Pp
Available when compiled with wide character string support:
.Ft int
.Fn libpff_check_file_signature_wide "const wchar_t *filename, libpff_error_t **error"
.Pp
Available when compiled with libbfio support:
.Ft int
.Fn libpff_check_file_signature_file_io_handle "libbfio_handle_t *bfio_handle, libpff_error_t **error"
.Pp
Notify functions
.Ft void
.Fn libpff_notify_set_verbose "int verbose"
.Ft int
.Fn libpff_notify_set_stream "FILE *stream, libpff_error_t **error"
.Ft int
.Fn libpff_notify_stream_open "const char *filename, libpff_error_t **error"
.Ft int
.Fn libpff_notify_stream_close "libpff_error_t **error"
.Pp
Error functions
.Ft void
.Fn libpff_error_free "libpff_error_t **error"
.Ft int
.Fn libpff_error_fprint "libpff_error_t *error, FILE *stream"
.Ft int
.Fn libpff_error_sprint "libpff_error_t *error, char *string, size_t size"
.Ft int
.Fn libpff_error_backtrace_fprint "libpff_error_t *error, FILE *stream"
.Ft int
.Fn libpff_error_backtrace_sprint "libpff_error_t *error, char *string, size_t size"
.Pp
File functions
.Ft int
.Fn libpff_file_initialize "libpff_file_t **file, libpff_error_t **error"
.Ft int
.Fn libpff_file_free "libpff_file_t **file, libpff_error_t **error"
.Ft int
.Fn libpff_file_signal_abort "libpff_file_t *file, libpff_error_t **error"
.Ft int
.Fn libpff_file_open "libpff_file_t *file, const char *filename, int flags, libpff_error_t **error"
.Ft int
.Fn libpff_file_close "libpff_file_t *file, libpff_error_t **error"
.Ft int
.Fn libpff_file_recover_items "libpff_file_t *file, uint8_t recovery_flags, libpff_error_t **error"
.Ft int
.Fn libpff_file_get_size "libpff_file_t *file, size64_t *size, libpff_error_t **error"
.Ft int
.Fn libpff_file_get_type "libpff_file_t *file, uint8_t *type, libpff_error_t **error"
.Ft int
.Fn libpff_file_get_encryption_type "libpff_file_t *file, uint8_t *encryption_type, libpff_error_t **error"
.Ft int
.Fn libpff_file_get_ascii_codepage "libpff_file_t *file, int *ascii_codepage, libpff_error_t **error"
.Ft int
.Fn libpff_file_set_ascii_codepage "libpff_file_t *file, int ascii_codepage, libpff_error_t **error"
.Ft int
.Fn libpff_file_get_number_of_unallocated_blocks "libpff_file_t *file, int unallocated_block_type, int *number_of_unallocated_blocks, libpff_error_t **error"
.Ft int
.Fn libpff_file_get_unallocated_block "libpff_file_t *file, int unallocated_block_type, int unallocated_block_index, off64_t *offset, size64_t *size, libpff_error_t **error"
.Ft int
.Fn libpff_file_get_root_item "libpff_file_t *file, libpff_item_t **root_item, libpff_error_t **error"
.Ft int
.Fn libpff_file_get_message_store "libpff_file_t *file, libpff_item_t **message_store, libpff_error_t **error"
.Ft int
.Fn libpff_file_get_root_folder "libpff_file_t *file, libpff_item_t **root_folder, libpff_error_t **error"
.Ft int
.Fn libpff_file_get_item_by_identifier "libpff_file_t *file, uint32_t item_identifier, libpff_item_t **item, libpff_error_t **error"
.Ft int
.Fn libpff_file_get_number_of_orphan_items "libpff_file_t *file, int *number_of_orphan_items, libpff_error_t **error"
.Ft int
.Fn libpff_file_get_orphan_item "libpff_file_t *file, int orphan_item_index, libpff_item_t **orphan_item, libpff_error_t **error"
.Ft int
.Fn libpff_file_get_number_of_recovered_items "libpff_file_t *file, int *number_of_recovered_items, libpff_error_t **error"
.Ft int
.Fn libpff_file_get_recovered_item "libpff_file_t *file, int recovered_item_index, libpff_item_t **recovered_item, libpff_error_t **error"
.Pp
Available when compiled with wide character string support:
.Ft int
.Fn libpff_file_open_wide "libpff_file_t *file, const wchar_t *filename, int flags, libpff_error_t **error"
.Pp
Available when compiled with libbfio support:
.Ft int
.Fn libpff_file_open_file_io_handle "libpff_file_t *file, libbfio_handle_t *file_io_handle, int flags, libpff_error_t **error"
.PP
Name to id map entry functions
.Ft int
.Fn libpff_name_to_id_map_entry_get_type "libpff_name_to_id_map_entry_t *name_to_id_map_entry, uint8_t *entry_type, libpff_error_t **error"
.Ft int
.Fn libpff_name_to_id_map_entry_get_number "libpff_name_to_id_map_entry_t *name_to_id_map_entry, uint32_t *number, libpff_error_t **error"
.Ft int
.Fn libpff_name_to_id_map_entry_get_utf8_string_size "libpff_name_to_id_map_entry_t *name_to_id_map_entry, size_t *utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_name_to_id_map_entry_get_utf8_string "libpff_name_to_id_map_entry_t *name_to_id_map_entry, uint8_t *utf8_string, size_t utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_name_to_id_map_entry_get_utf16_string_size "libpff_name_to_id_map_entry_t *name_to_id_map_entry, size_t *utf16_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_name_to_id_map_entry_get_utf16_string "libpff_name_to_id_map_entry_t *name_to_id_map_entry, uint16_t *utf16_string, size_t utf16_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_name_to_id_map_entry_get_guid "libpff_name_to_id_map_entry_t *name_to_id_map_entry, uint8_t *guid, size_t size, libpff_error_t **error"
.PP
Item functions
.Ft int
.Fn libpff_item_clone "libpff_item_t **destination_item, libpff_item_t *source_item, libpff_error_t **error"
.Ft int
.Fn libpff_item_free "libpff_item_t **item, libpff_error_t **error"
.Ft int
.Fn libpff_item_get_identifier "libpff_item_t *item, uint32_t *identifier, libpff_error_t **error"
.Ft int
.Fn libpff_item_get_number_of_sets "libpff_item_t *item, uint32_t *number_of_sets, libpff_error_t **error"
.Ft int
.Fn libpff_item_get_number_of_entries "libpff_item_t *item, uint32_t *number_of_entries, libpff_error_t **error"
.Ft int
.Fn libpff_item_get_entry_type "libpff_item_t *item, int set_index, int entry_index, uint32_t *entry_type, uint32_t *value_type, libpff_name_to_id_map_entry_t **name_to_id_map_entry, libpff_error_t **error"
.Ft int
.Fn libpff_item_get_value_type "libpff_item_t *item, int set_index, uint32_t entry_type, uint32_t *value_type, uint8_t flags, libpff_error_t **error"
.Ft int
.Fn libpff_item_get_entry_value "libpff_item_t *item, int set_index, uint32_t entry_type, uint32_t *value_type, uint8_t **value_data, size_t *value_data_size, uint8_t flags, libpff_error_t **error"
.Ft int
.Fn libpff_item_get_entry_value_by_utf8_name "libpff_item_t *item, int set_index, uint8_t* utf8_entry_name, size_t utf8_entry_name_size, uint32_t *value_type, uint8_t **value_data, size_t *value_data_size, libpff_error_t **error"
.Ft int
.Fn libpff_item_get_entry_value_by_utf16_name "libpff_item_t *item, int set_index, uint16_t* utf16_entry_name, size_t utf16_entry_name_size, uint32_t *value_type, uint8_t **value_data, size_t *value_data_size, libpff_error_t **error"
.Ft int
.Fn libpff_item_get_entry_value_boolean "libpff_item_t *item, int set_index, uint32_t entry_type, uint8_t *entry_value, uint8_t flags, libpff_error_t **error"
.Ft int
.Fn libpff_item_get_entry_value_16bit "libpff_item_t *item, int set_index, uint32_t entry_type, uint16_t *entry_value, uint8_t flags, libpff_error_t **error"
.Ft int
.Fn libpff_item_get_entry_value_32bit "libpff_item_t *item, int set_index, uint32_t entry_type, uint32_t *entry_value, uint8_t flags, libpff_error_t **error"
.Ft int
.Fn libpff_item_get_entry_value_64bit "libpff_item_t *item, int set_index, uint32_t entry_type, uint64_t *entry_value, uint8_t flags, libpff_error_t **error"
.Ft int
.Fn libpff_item_get_entry_value_filetime "libpff_item_t *item, int set_index, uint32_t entry_type, uint64_t *entry_value, uint8_t flags, libpff_error_t **error"
.Ft int
.Fn libpff_item_get_entry_value_size "libpff_item_t *item, int set_index, uint32_t entry_type, size_t *entry_value, uint8_t flags, libpff_error_t **error"
.Ft int
.Fn libpff_item_get_entry_value_floating_point "libpff_item_t *item, int set_index, uint32_t entry_type, double *entry_value, uint8_t flags, libpff_error_t **error"
.Ft int
.Fn libpff_item_get_entry_value_utf8_string_size "libpff_item_t *item, int set_index, uint32_t entry_type, size_t *utf8_string_size, uint8_t flags, libpff_error_t **error"
.Ft int
.Fn libpff_item_get_entry_value_utf8_string "libpff_item_t *item, int set_index, uint32_t entry_type, uint8_t *utf8_string, size_t utf8_string_size, uint8_t flags, libpff_error_t **error"
.Ft int
.Fn libpff_item_get_entry_value_utf16_string_size "libpff_item_t *item, int set_index, uint32_t entry_type, size_t *utf16_string_size, uint8_t flags, libpff_error_t **error"
.Ft int
.Fn libpff_item_get_entry_value_utf16_string "libpff_item_t *item, int set_index, uint32_t entry_type, uint8_t *utf16_string, size_t utf16_string_size, uint8_t flags, libpff_error_t **error"
.Ft int
.Fn libpff_item_get_entry_value_binary_data_size "libpff_item_t *item, int set_index, uint32_t entry_type, size_t *size, uint8_t flags, libpff_error_t **error"
.Ft int
.Fn libpff_item_get_entry_value_binary_data "libpff_item_t *item, int set_index, uint32_t entry_type, uint8_t *binary_data, size_t size, uint8_t flags, libpff_error_t **error"
.Ft int
.Fn libpff_item_get_entry_value_guid "libpff_item_t *item, int set_index, uint32_t entry_type, uint8_t *guid, size_t size, uint8_t flags, libpff_error_t **error"
.Ft int
.Fn libpff_item_get_entry_multi_value "libpff_item_t *item, int set_index, uint32_t entry_type, libpff_multi_value_t **multi_value, uint8_t flags, libpff_error_t **error"
.Ft int
.Fn libpff_item_get_type "libpff_item_t *item, uint8_t *item_type, libpff_error_t **error"
.Ft int
.Fn libpff_item_get_number_of_sub_items "libpff_item_t *item, int *number_of_sub_items, libpff_error_t **error"
.Ft int
.Fn libpff_item_get_sub_item "libpff_item_t *item, int sub_item_index, libpff_item_t **sub_item, libpff_error_t **error"
.Ft int
.Fn libpff_item_get_sub_item_by_identifier "libpff_item_t *item, uint32_t sub_item_identifier, libpff_item_t **sub_item, libpff_error_t **error"
.Ft int
.Fn libpff_item_get_utf8_display_name_size "libpff_item_t *item, size_t *utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_item_get_utf8_display_name "libpff_item_t *item, uint8_t *utf8_string, size_t utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_item_get_utf16_display_name_size "libpff_item_t *item, size_t *utf16_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_item_get_utf16_display_name "libpff_item_t *item, uint16_t *utf16_string, size_t utf16_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_item_get_utf8_address_type_size "libpff_item_t *item, size_t *utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_item_get_utf8_address_type "libpff_item_t *item, uint8_t *utf8_string, size_t utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_item_get_utf16_address_type_size "libpff_item_t *item, size_t *utf16_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_item_get_utf16_address_type "libpff_item_t *item, uint16_t *utf16_string, size_t utf16_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_item_get_utf8_email_address_size "libpff_item_t *item, size_t *utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_item_get_utf8_email_address "libpff_item_t *item, uint8_t *utf8_string, size_t utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_item_get_utf16_email_address_size "libpff_item_t *item, size_t *utf16_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_item_get_utf16_email_address "libpff_item_t *item, uint16_t *utf16_string, size_t utf16_string_size, libpff_error_t **error"
.Pp
Multi value functions
.Ft int
.Fn libpff_multi_value_free "libpff_multi_value_t **multi_value, libpff_error_t **error"
.Ft int
.Fn libpff_multi_value_get_number_of_values "libpff_multi_value_t *multi_value, int *number_of_values, libpff_error_t **error"
.Ft int
.Fn libpff_multi_value_get_entry_value "libpff_multi_value_t *multi_value, int value_index, uint32_t *value_type, uint8_t **value_data, size_t *value_data_size, libpff_error_t **error"
.Ft int
.Fn libpff_multi_value_get_value_32bit "libpff_multi_value_t *multi_value, int value_index, uint32_t *value, libpff_error_t **error"
.Ft int
.Fn libpff_multi_value_get_value_64bit "libpff_multi_value_t *multi_value, int value_index, uint64_t *value, libpff_error_t **error"
.Ft int
.Fn libpff_multi_value_get_value_filetime "libpff_multi_value_t *multi_value, int value_index, uint64_t *filetime, libpff_error_t **error"
.Ft int
.Fn libpff_multi_value_get_value_utf8_string_size "libpff_multi_value_t *multi_value, int value_index, size_t *utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_multi_value_get_value_utf8_string "libpff_multi_value_t *multi_value, int value_index, uint8_t *utf8_string, size_t utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_multi_value_get_value_utf16_string_size "libpff_multi_value_t *multi_value, int value_index, size_t *utf16_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_multi_value_get_value_utf16_string "libpff_multi_value_t *multi_value, int value_index, uint16_t *utf16_string, size_t utf16_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_multi_value_get_value_binary_data_size "libpff_multi_value_t *multi_value, int value_index, size_t *size, libpff_error_t **error"
.Ft int
.Fn libpff_multi_value_get_value_binary_data "libpff_multi_value_t *multi_value, int value_index, uint8_t *binary_data, size_t size, libpff_error_t **error"
.Ft int
.Fn libpff_multi_value_get_value_guid "libpff_multi_value_t *multi_value, int value_index, uint8_t *guid, size_t size, libpff_error_t **error"
.Pp
Folder functions
.Ft int
.Fn libpff_folder_get_utf8_name_size "libpff_item_t *folder, size_t *utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_folder_get_utf8_name "libpff_item_t *folder, uint8_t *utf8_string, size_t utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_folder_get_utf16_name_size "libpff_item_t *folder, size_t *utf16_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_folder_get_utf16_name "libpff_item_t *folder, uint16_t *utf16_string, size_t utf16_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_folder_get_type "libpff_item_t *folder, uint8_t *type, libpff_error_t **error"
.Ft int
.Fn libpff_folder_get_number_of_sub_folders "libpff_item_t *folder, int *number_of_sub_folders, libpff_error_t **error"
.Ft int
.Fn libpff_folder_get_sub_folder "libpff_item_t *folder, int sub_folder_index, libpff_item_t **sub_folder, libpff_error_t **error"
.Ft int
.Fn libpff_folder_get_sub_folder_by_utf8_name "libpff_item_t *folder, uint8_t *utf8_sub_folder_name, size_t utf8_sub_folder_name_size, libpff_item_t **sub_folder, libpff_error_t **error"
.Ft int
.Fn libpff_folder_get_sub_folder_by_utf16_name "libpff_item_t *folder, uint16_t *utf16_sub_folder_name, size_t utf16_sub_folder_name_size, libpff_item_t **sub_folder, libpff_error_t **error"
.Ft int
.Fn libpff_folder_get_sub_folders "libpff_item_t *folder, libpff_item_t **sub_folders, libpff_error_t **error"
.Ft int
.Fn libpff_folder_get_number_of_sub_messages "libpff_item_t *folder, int *number_of_sub_messages, libpff_error_t **error"
.Ft int
.Fn libpff_folder_get_sub_message "libpff_item_t *folder, int sub_message_index, libpff_item_t **sub_message, libpff_error_t **error"
.Fn libpff_folder_get_sub_message_by_utf8_name "libpff_item_t *folder, uint8_t *utf8_sub_message_name, size_t utf8_sub_message_name_size, libpff_item_t **sub_message, libpff_error_t **error"
.Ft int
.Fn libpff_folder_get_sub_message_by_utf16_name "libpff_item_t *folder, uint16_t *utf16_sub_message_name, size_t utf16_sub_message_name_size, libpff_item_t **sub_message, libpff_error_t **error"
.Ft int
.Ft int
.Fn libpff_folder_get_sub_messages "libpff_item_t *folder, libpff_item_t **sub_messages, libpff_error_t **error"
.Ft int
.Fn libpff_folder_get_number_of_sub_associated_contents "libpff_item_t *folder, int *number_of_sub_associated_contents, libpff_error_t **error"
.Ft int
.Fn libpff_folder_get_sub_associated_content "libpff_item_t *folder, int sub_associated_content_index, libpff_item_t **sub_associated_content, libpff_error_t **error"
.Ft int
.Fn libpff_folder_get_sub_associated_contents "libpff_item_t *folder, libpff_item_t **sub_associated_contents, libpff_error_t **error"
.Pp
Message store functions
.Ft int
.Fn libpff_message_store_get_valid_folder_mask "libpff_item_t *message_store, uint32_t *valid_folder_mask, libpff_error_t **error"
.Ft int
.Fn libpff_message_store_get_password_checksum "libpff_item_t *message_store, uint32_t *password_checksum, libpff_error_t **error"
.Pp
Message functions
.Ft int
.Fn libpff_message_get_entry_value_utf8_string_size "libpff_item_t *message, uint32_t entry_type, size_t *utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_message_get_entry_value_utf8_string "libpff_item_t *message, uint32_t entry_type, uint8_t *utf8_string, size_t utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_message_get_entry_value_utf16_string_size "libpff_item_t *message, uint32_t entry_type, size_t *utf16_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_message_get_entry_value_utf16_string "libpff_item_t *message, uint32_t entry_type, uint16_t *utf16_string, size_t utf16_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_message_get_number_of_attachments "libpff_item_t *message, int *number_of_attachments, libpff_error_t **error"
.Ft int
.Fn libpff_message_get_attachment "libpff_item_t *message, int attachment_index, libpff_item_t **attachment, libpff_error_t **error"
.Ft int
.Fn libpff_message_get_attachments "libpff_item_t *message, libpff_item_t **attachments, libpff_error_t **error"
.Ft int
.Fn libpff_message_get_recipients "libpff_item_t *message, libpff_item_t **recipients, libpff_error_t **error"
.Ft int
.Fn libpff_message_get_utf8_class_size "libpff_item_t *message, size_t *utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_message_get_utf8_class "libpff_item_t *message, uint8_t *utf8_string, size_t utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_message_get_utf8_subject_size *subject_size "libpff_item_t *message, size_t *utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_message_get_utf8_subject "libpff_item_t *message, uint8_t *utf8_string, size_t utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_message_get_utf8_conversation_topic_size "libpff_item_t *message, size_t *utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_message_get_utf8_conversation_topic "libpff_item_t *message, uint8_t *utf8_string, size_t utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_message_get_conversation_index_size "libpff_item_t *message, size_t *size, libpff_error_t **error"
.Ft int
.Fn libpff_message_get_conversation_index "libpff_item_t *message, uint8_t *conversation_index, size_t size, libpff_error_t **error"
.Ft int
.Fn libpff_message_get_utf8_sender_name_size "libpff_item_t *message, size_t *utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_message_get_utf8_sender_name "libpff_item_t *message, uint8_t *utf8_string, size_t utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_message_get_utf16_sender_name_size "libpff_item_t *message, size_t *utf16_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_message_get_utf16_sender_name "libpff_item_t *message, uint16_t *utf16_string, size_t utf16_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_message_get_utf8_sender_email_address_size "libpff_item_t *message, size_t *utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_message_get_utf8_sender_email_address "libpff_item_t *message, uint8_t *utf8_string, size_t utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_message_get_utf16_sender_email_address_size "libpff_item_t *message, size_t *utf16_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_message_get_utf16_sender_email_address "libpff_item_t *message, uint16_t *utf16_string, size_t utf16_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_message_get_utf8_sent_representing_name_size "libpff_item_t *message, size_t *utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_message_get_utf8_sent_representing_name "libpff_item_t *message, uint8_t *utf8_string, size_t utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_message_get_utf16_sent_representing_name_size "libpff_item_t *message, size_t *utf16_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_message_get_utf16_sent_representing_name "libpff_item_t *message, uint16_t *utf16_string, size_t utf16_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_message_get_utf8_sent_representing_email_address_size "libpff_item_t *message, size_t *utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_message_get_utf8_sent_representing_email_address "libpff_item_t *message, uint8_t *utf8_string, size_t utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_message_get_utf16_sent_representing_email_address_size "libpff_item_t *message, size_t *utf16_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_message_get_utf16_sent_representing_email_address "libpff_item_t *message, uint16_t *utf16_string, size_t utf16_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_message_get_utf8_received_by_name_size "libpff_item_t *message, size_t *utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_message_get_utf8_received_by_name "libpff_item_t *message, uint8_t *utf8_string, size_t utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_message_get_utf16_received_by_name_size "libpff_item_t *message, size_t *utf16_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_message_get_utf16_received_by_name "libpff_item_t *message, uint16_t *utf16_string, size_t utf16_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_message_get_utf8_received_by_email_address_size "libpff_item_t *message, size_t *utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_message_get_utf8_received_by_email_address "libpff_item_t *message, uint8_t *utf8_string, size_t utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_message_get_utf16_received_by_email_address_size "libpff_item_t *message, size_t *utf16_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_message_get_utf16_received_by_email_address "libpff_item_t *message, uint16_t *utf16_string, size_t utf16_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_message_get_importance "libpff_item_t *message, uint32_t *importance, libpff_error_t **error"
.Ft int
.Fn libpff_message_get_priority "libpff_item_t *message, uint32_t *priority, libpff_error_t **error"
.Ft int
.Fn libpff_message_get_sensitivity "libpff_item_t *message, uint32_t *sensitivity, libpff_error_t **error"
.Ft int
.Fn libpff_message_get_flags "libpff_item_t *message, uint32_t *flags, libpff_error_t **error"
.Ft int
.Fn libpff_message_get_size "libpff_item_t *message, uint32_t *size, libpff_error_t **error"
.Ft int
.Fn libpff_message_get_client_submit_time "libpff_item_t *message, uint64_t *client_submit_time, libpff_error_t **error"
.Ft int
.Fn libpff_message_get_delivery_time "libpff_item_t *message, uint64_t *delivery_time, libpff_error_t **error"
.Ft int
.Fn libpff_message_get_creation_time "libpff_item_t *message, uint64_t *creation_time, libpff_error_t **error"
.Ft int
.Fn libpff_message_get_modification_time "libpff_item_t *message, uint64_t *modification_time, libpff_error_t **error"
.Ft int
.Fn libpff_message_get_utf8_transport_headers_size "libpff_item_t *message, size_t *utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_message_get_utf8_transport_headers "libpff_item_t *message, uint8_t *utf8_string, size_t utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_message_get_utf16_transport_headers_size "libpff_item_t *message, size_t *utf16_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_message_get_utf16_transport_headers "libpff_item_t *message, uint16_t *utf16_string, size_t utf16_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_message_get_plain_text_body_size "libpff_item_t *message, size_t *size, libpff_error_t **error"
.Ft int
.Fn libpff_message_get_plain_text_body "libpff_item_t *message, uint8_t *plain_text_body, size_t size, libpff_error_t **error"
.Ft int
.Fn libpff_message_get_rtf_body_size "libpff_item_t *message, size_t *size, libpff_error_t **error"
.Ft int
.Fn libpff_message_get_body "libpff_item_t *message, uint8_t *rtf_body, size_t size, libpff_error_t **error"
.Ft int
.Fn libpff_message_get_html_body_size "libpff_item_t *message, size_t *size, libpff_error_t **error"
.Ft int
.Fn libpff_message_get_html_body "libpff_item_t *message, uint8_t *html_body, size_t size, libpff_error_t **error"
.Pp
Appointment functions
.Ft int
.Fn libpff_appointment_get_utf8_location_size "libpff_item_t *appointment, size_t *utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_appointment_get_utf8_location "libpff_item_t *appointment, uint8_t *utf8_string, size_t utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_appointment_get_utf16_location_size "libpff_item_t *appointment, size_t *utf16_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_appointment_get_utf16_location "libpff_item_t *appointment, uint16_t *utf16_string, size_t utf16_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_appointment_start_time "libpff_item_t *appointment, uint64_t *start_time, libpff_error_t **error"
.Ft int
.Fn libpff_appointment_end_time "libpff_item_t *appointment, uint64_t *end_time, libpff_error_t **error"
.Ft int
.Fn libpff_appointment_get_utf8_recurring_pattern_size "libpff_item_t *appointment, size_t *utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_appointment_get_utf8_recurring_pattern "libpff_item_t *appointment, uint8_t *utf8_string, size_t utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_appointment_get_utf16_recurring_pattern_size "libpff_item_t *appointment, size_t *utf16_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_appointment_get_utf16_recurring_pattern "libpff_item_t *appointment, uint16_t *utf16_string, size_t utf16_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_appointment_get_utf8_timezone_description_size "libpff_item_t *appointment, size_t *utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_appointment_get_utf8_timezone_description "libpff_item_t *appointment, uint8_t *utf8_string, size_t utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_appointment_get_utf16_timezone_description_size "libpff_item_t *appointment, size_t *utf16_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_appointment_get_utf16_timezone_description "libpff_item_t *appointment, uint16_t *utf16_string, size_t utf16_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_appointment_first_effective_time "libpff_item_t *message, uint64_t *first_effective_time, libpff_error_t **error"
.Ft int
.Fn libpff_appointment_last_effective_time "libpff_item_t *message, uint64_t *last_effective_time, libpff_error_t **error"
.Pp
Address functions
.Ft int
.Fn libpff_address_get_utf8_file_under_size "libpff_item_t *address, size_t *utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_address_get_utf8_file_under "libpff_item_t *address, uint8_t *utf8_string, size_t utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_address_get_utf16_file_under_size "libpff_item_t *address, size_t *utf16_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_address_get_utf16_file_under "libpff_item_t *address, uint16_t *utf16_string, size_t utf16_string_size, libpff_error_t **error"
.Pp
Contact functions
.Ft int
.Fn libpff_contact_get_utf8_file_as_size "libpff_item_t *contact, size_t *utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_contact_get_utf8_file_as "libpff_item_t *contact, uint8_t *utf8_string, size_t utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_contact_get_utf16_file_as_size "libpff_item_t *contact, size_t *utf16_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_contact_get_utf16_file_as "libpff_item_t *contact, uint16_t *utf16_string, size_t utf16_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_contact_get_utf8_postal_address_size "libpff_item_t *contact, size_t *utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_contact_get_utf8_postal_address "libpff_item_t *contact, uint8_t *utf8_string, size_t utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_contact_get_utf16_postal_address_size "libpff_item_t *contact, size_t *utf16_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_contact_get_utf16_postal_address "libpff_item_t *contact, uint16_t *utf16_string, size_t utf16_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_contact_get_utf8_company_name_size "libpff_item_t *contact, size_t *utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_contact_get_utf8_company_name "libpff_item_t *contact, uint8_t *utf8_string, size_t utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_contact_get_utf16_company_name_size "libpff_item_t *contact, size_t *utf16_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_contact_get_utf16_company_name "libpff_item_t *contact, uint16_t *utf16_string, size_t utf16_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_contact_get_utf8_department_name_size "libpff_item_t *contact, size_t *utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_contact_get_utf8_department_name "libpff_item_t *contact, uint8_t *utf8_string, size_t utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_contact_get_utf16_department_name_size "libpff_item_t *contact, size_t *utf16_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_contact_get_utf16_department_name "libpff_item_t *contact, uint16_t *utf16_string, size_t utf16_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_contact_get_utf8_office_location_size "libpff_item_t *contact, size_t *utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_contact_get_utf8_office_location "libpff_item_t *contact, uint8_t *utf8_string, size_t utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_contact_get_utf16_office_location_size "libpff_item_t *contact, size_t *utf16_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_contact_get_utf16_office_location "libpff_item_t *contact, uint16_t *utf16_string, size_t utf16_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_contact_get_utf8_callback_phone_number_size "libpff_item_t *contact, size_t *utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_contact_get_utf8_callback_phone_number "libpff_item_t *contact, uint8_t *utf8_string, size_t utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_contact_get_utf16_callback_phone_number_size "libpff_item_t *contact, size_t *utf16_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_contact_get_utf16_callback_phone_number "libpff_item_t *contact, uint16_t *utf16_string, size_t utf16_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_contact_get_utf8_primary_phone_number_size "libpff_item_t *contact, size_t *utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_contact_get_utf8_primary_phone_number "libpff_item_t *contact, uint8_t *utf8_string, size_t utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_contact_get_utf16_primary_phone_number_size "libpff_item_t *contact, size_t *utf16_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_contact_get_utf16_primary_phone_number "libpff_item_t *contact, uint16_t *utf16_string, size_t utf16_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_contact_get_utf8_home_phone_number_size "libpff_item_t *contact, size_t *utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_contact_get_utf8_home_phone_number "libpff_item_t *contact, uint8_t *utf8_string, size_t utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_contact_get_utf16_home_phone_number_size "libpff_item_t *contact, size_t *utf16_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_contact_get_utf16_home_phone_number "libpff_item_t *contact, uint16_t *utf16_string, size_t utf16_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_contact_get_utf8_business_phone_number_1_size "libpff_item_t *contact, size_t *utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_contact_get_utf8_business_phone_number_1 "libpff_item_t *contact, uint8_t *utf8_string, size_t utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_contact_get_utf16_business_phone_number_1_size "libpff_item_t *contact, size_t *utf16_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_contact_get_utf16_business_phone_number_1 "libpff_item_t *contact, uint16_t *utf16_string, size_t utf16_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_contact_get_utf8_business_phone_number_2_size "libpff_item_t *contact, size_t *utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_contact_get_utf8_business_phone_number_2 "libpff_item_t *contact, uint8_t *utf8_string, size_t utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_contact_get_utf16_business_phone_number_2_size "libpff_item_t *contact, size_t *utf16_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_contact_get_utf16_business_phone_number_2 "libpff_item_t *contact, uint16_t *utf16_string, size_t utf16_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_contact_get_utf8_mobile_phone_number_size "libpff_item_t *contact, size_t *utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_contact_get_utf8_mobile_phone_number "libpff_item_t *contact, uint8_t *utf8_string, size_t utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_contact_get_utf16_mobile_phone_number_size "libpff_item_t *contact, size_t *utf16_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_contact_get_utf16_mobile_phone_number "libpff_item_t *contact, uint16_t *utf16_string, size_t utf16_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_contact_get_utf8_business_fax_number_size "libpff_item_t *contact, size_t *utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_contact_get_utf8_business_fax_number "libpff_item_t *contact, uint8_t *utf8_string, size_t utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_contact_get_utf16_business_fax_number_size "libpff_item_t *contact, size_t *utf16_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_contact_get_utf16_business_fax_number "libpff_item_t *contact, uint16_t *utf16_string, size_t utf16_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_contact_get_utf8_country_size "libpff_item_t *contact, size_t *utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_contact_get_utf8_country "libpff_item_t *contact, uint8_t *utf8_string, size_t utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_contact_get_utf16_country_size "libpff_item_t *contact, size_t *utf16_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_contact_get_utf16_country "libpff_item_t *contact, uint16_t *utf16_string, size_t utf16_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_contact_get_utf8_locality_size "libpff_item_t *contact, size_t *utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_contact_get_utf8_locality "libpff_item_t *contact, uint8_t *utf8_string, size_t utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_contact_get_utf16_locality_size "libpff_item_t *contact, size_t *utf16_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_contact_get_utf16_locality "libpff_item_t *contact, uint16_t *utf16_string, size_t utf16_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_contact_get_utf8_title_size "libpff_item_t *contact, size_t *utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_contact_get_utf8_title "libpff_item_t *contact, uint8_t *utf8_string, size_t utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_contact_get_utf16_title_size "libpff_item_t *contact, size_t *utf16_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_contact_get_utf16_title "libpff_item_t *contact, uint16_t *utf16_string, size_t utf16_string_size, libpff_error_t **error"
.Pp
E-mail functions
.Ft int
.Fn libpff_email_get_utf8_filename_size "libpff_item_t *email, size_t *utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_email_get_utf8_filename "libpff_item_t *email, uint8_t *utf8_string, size_t utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_email_get_utf16_filename_size "libpff_item_t *email, size_t *utf16_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_email_get_utf16_filename "libpff_item_t *email, uint16_t *utf16_string, size_t utf16_string_size, libpff_error_t **error"
.Pp
Attachment functions
.Ft int
.Fn libpff_attachment_get_utf8_short_filename_size "libpff_item_t *attachment, size_t utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_attachment_get_utf8_short_filename "libpff_item_t *attachment, uint8_t *utf8_string, size_t utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_attachment_get_utf16_short_filename_size "libpff_item_t *attachment, size_t utf16_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_attachment_get_utf16_short_filename "libpff_item_t *attachment, uint16_t *utf16_string, size_t utf16_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_attachment_get_utf8_long_filename_size "libpff_item_t *attachment, size_t utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_attachment_get_utf8_long_filename "libpff_item_t *attachment, uint8_t *utf8_string, size_t utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_attachment_get_utf16_long_filename_size "libpff_item_t *attachment, size_t utf16_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_attachment_get_utf16_long_filename "libpff_item_t *attachment, uint16_t *utf16_string, size_t utf16_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_attachment_get_data_size "libpff_item_t *attachment, size64_t *size, libpff_error_t **error"
.Ft ssize_t
.Fn libpff_attachment_data_read_buffer "libpff_item_t *attachment, uint8_t *buffer, size_t buffer_size, libpff_error_t **error"
.Ft off64_
.Fn libpff_attachment_data_seek_offset "libpff_item_t *attachment, off64_t offset, int whence, libpff_error_t **error"
.Ft int
.Fn libpff_attachment_get_item "libpff_item_t *attachment, libpff_item_t **attached_item, libpff_error_t **error"
.Pp
Available when compiled with libbfio support:
.Ft int
.Fn libpff_attachment_get_data_file_io_handle "libpff_item_t *attachment, libbfio_handle_t **file_io_handle, libpff_error_t **error"
.Pp
Recipients functions
.Ft int
.Fn libpff_recipients_get_utf8_display_name_size "libpff_item_t *recipients, int recipient_index, size_t *utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_recipients_get_utf8_display_name "libpff_item_t *recipients, int recipient_index, uint8_t *utf8_string, size_t utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_recipients_get_utf16_display_name_size "libpff_item_t *recipients, int recipient_index, size_t *utf16_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_recipients_get_utf16_display_name "libpff_item_t *recipients, int recipient_index, uint16_t *utf16_string, size_t utf16_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_recipients_get_utf8_address_type_size "libpff_item_t *recipients, int recipient_index, size_t *utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_recipients_get_utf8_address_type "libpff_item_t *recipients, int recipient_index, uint8_t *utf8_string, size_t utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_recipients_get_utf16_address_type_size "libpff_item_t *recipients, int recipient_index, size_t *utf16_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_recipients_get_utf16_address_type "libpff_item_t *recipients, int recipient_index, uint16_t *utf16_string, size_t utf16_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_recipients_get_utf8_email_address_size "libpff_item_t *recipients, int recipient_index, size_t *utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_recipients_get_utf8_email_address "libpff_item_t *recipients, int recipient_index, uint8_t *utf8_string, size_t utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_recipients_get_utf16_email_address_size "libpff_item_t *recipients, int recipient_index, size_t *utf16_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_recipients_get_utf16_email_address "libpff_item_t *recipients, int recipient_index, uint16_t *utf16_string, size_t utf16_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_recipients_get_utf8_recipient_display_name_size "libpff_item_t *recipients, int recipient_index, size_t *utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_recipients_get_utf8_recipient_display_name "libpff_item_t *recipients, int recipient_index, uint8_t *utf8_string, size_t utf8_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_recipients_get_utf16_recipient_display_name_size "libpff_item_t *recipients, int recipient_index, size_t *utf16_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_recipients_get_utf16_recipient_display_name "libpff_item_t *recipients, int recipient_index, uint16_t *utf16_string, size_t utf16_string_size, libpff_error_t **error"
.Ft int
.Fn libpff_recipients_get_type "libpff_item_t *recipients, int recipient_index, uint32_t *type, libpff_error_t **error"
.Sh DESCRIPTION
The
.Fn libpff_get_version
function is used to retrieve the library version.
.Sh RETURN VALUES
Most of the functions return NULL or \-1 on error, dependent on the return type. For the actual return values refer to libpff.h
.Sh ENVIRONMENT
None
.Sh FILES
None
.Sh NOTES
libpff mainly uses UTF-8 encoded strings except for filenames, but provides several UTF-16 functions.

ASCII strings in a PFF file contain an extended ASCII string using the codepage of the system it was created on. The function
.Ar libpff_set_ascii_codepage
 allows to set the required codepage for reading and writing. The default codepage is ASCII and replaces all extended characters to the Unicode replacement character (U+fffd) when reading and the ASCII substitude character (0x1a) when writing.

libpff allows to be compiled with wide character support.
To compile libpff with wide character support use
.Ar ./configure --enable-wide-character-type=yes
or pass the definition
.Ar _UNICODE
 or
.Ar UNICODE
 to the compiler (i.e. in case of Microsoft Visual Studio (MSVS) C++).

To have other code to determine if libpff was compiled with wide character support it defines
.Ar LIBPFF_HAVE_WIDE_CHARACTER_TYPE
 in libpff/features.h.

libpff allows to be compiled with chained IO support using libbfio.
libpff will automatically detect if a compatible version of libbfio is available.

To have other code to determine if libpff was compiled with libbfio support it defines
.Ar LIBPFF_HAVE_BFIO
 in libpff/features.h.

.Sh BUGS
Please report bugs of any kind to <joachim.metz@gmail.com> or on the project website:
http://code.google.com/p/libpff/
.Sh AUTHOR
These man pages were written by Joachim Metz.
.Sh COPYRIGHT
Copyright 2008-2012 Joachim Metz <joachim.metz@gmail.com>.
This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
.Sh SEE ALSO
the libpff.h include file