From fe8858c4e913993a45e9df5874dea75f9478819f Mon Sep 17 00:00:00 2001 From: Mathias Palm Date: Sun, 10 Feb 2013 20:13:03 +0100 Subject: Add manpages Provides manpages instead of generating them from c2man as c2man is deprecated. --- doc/vf_get_next_object.3 | 65 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 65 insertions(+) create mode 100644 doc/vf_get_next_object.3 (limited to 'doc/vf_get_next_object.3') diff --git a/doc/vf_get_next_object.3 b/doc/vf_get_next_object.3 new file mode 100644 index 0000000..9c8efbe --- /dev/null +++ b/doc/vf_get_next_object.3 @@ -0,0 +1,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) -- cgit v1.1-32-gdbae