summaryrefslogtreecommitdiffstats
path: root/doc/vf_get_next_object.3
blob: 9c8efbebef2fc4c247a69b6d5703535bc2485f91 (plain)
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
.\" WARNING! THIS FILE WAS GENERATED AUTOMATICALLY BY c2man!
.\" DO NOT EDIT! CHANGES MADE TO THIS FILE WILL BE LOST!
.TH "vf_get_next_object" 3 "30 April 2003" "c2man vf_iface.h"
.SH "NAME"
vf_get_next_object \- vf_get_next_object()
.SH "SYNOPSIS"
.ft B
#include <../vformat/vf_iface.h>
.sp
extern bool_t vf_get_next_object(VF_OBJECT_T **pp_object);
.ft R
.SH "PARAMETERS"
.TP
.B "VF_OBJECT_T **pp_object"
Ptr to pointer to current object.
.SH "DESCRIPTION"
Find "next" vobject.  Typically called after a call to vf_read_file()
which may well read a list of objects from a file for example:

if (vf_read_file(&p_object, p_filename))
{
do
{
\ ...
}
while (vf_get_next_object(&p_object))
;
}

The value of *pp_object is updated by the call if it returns TRUE.
.SH "RETURNS"
TRUE iff found (ie. There is a "next" object).
.SH "SEE ALSO"
vf_parse_init(3),
vf_parse_text(3),
vf_parse_end(3),
vf_read_file(3),
vf_write_file(3),
vf_create_object(3),
vf_get_object_type(3),
vf_get_property(3),
vf_get_property_ex(3),
vf_get_next_property(3),
vf_get_prop_value(3),
vf_set_prop_value(3),
vf_get_prop_value_string(3),
vf_get_prop_name_string(3),
vf_set_prop_name_string(3),
vf_get_prop_name(3),
vf_get_prop_value_object(3),
vf_set_prop_value_object(3),
vf_set_prop_value_string(3),
vf_set_prop_value_base64(3),
vf_get_prop_value_base64(3),
vf_set_property_from_file(3),
vf_delete_object(3),
vf_delete_prop(3),
vf_find_prop_qual_index(3),
vf_is_modified(3),
vf_find_charset(3),
vf_date_string_to_time(3),
vf_period_string_to_time(3),
vf_period_time_to_string(3),
vf_set_prop_value_time(3),
vf_get_prop_value_time(3)