.\" WARNING! THIS FILE WAS GENERATED AUTOMATICALLY BY c2man!
.\" DO NOT EDIT! CHANGES MADE TO THIS FILE WILL BE LOST!
.TH "vf_find_prop_qual_index" 3 "30 April 2003" "c2man vf_iface.h"
.SH "NAME"
vf_find_prop_qual_index \- vf_find_prop_qual_index()
.SH "SYNOPSIS"
.ft B
#include <../vformat/vf_iface.h>
.sp
extern bool_t vf_find_prop_qual_index
.br
(
.br
	VF_PROP_T *p_prop,
.br
	uint32_t *p_qualifier_index,
.br
	uint32_t *p_found_value_index,
.br
	const char **pp_possible_values,
.br
	const char *p_token,
.br
	vf_search_flags_t match
.br
);
.ft R
.SH "PARAMETERS"
.TP
.B "VF_PROP_T *p_prop"
The property we're querying.
.TP
.B "uint32_t *p_qualifier_index"
Ptr to output name index.
.TP
.B "uint32_t *p_found_value_index"
Ptr to output index in array.
.TP
.B "const char **pp_possible_values"
Array of possible values.
.TP
.B "const char *p_token"
Token searched for.
.TP
.B "vf_search_flags_t match"
String comparison flags.
.SH "DESCRIPTION"
Locate property qualifier given either an array of possible values
or a single token that is either present or absent.  For example
if we have a property:

NAME;THIRD;TIME;LUCKY:VALUE1;VALUE2;VALUE3

Then there are two possible searches.

Firstly we can look for the property qualifier which can take values
from the array { "FIRST", "SECOND", THIRD" } in which case the array
is passed as pp_possible_values and the function returns with the
values *p_found_value_index=2, p_qualifier_index=1

Secondly we can look for the token with value "TIME" in which case
p_token is set to "TIME" and the function returns *p_qualifier_index=2.
.SH "RETURNS"
TRUE iff found, FALSE else.
.SH "SEE ALSO"
vf_parse_init(3),
vf_parse_text(3),
vf_parse_end(3),
vf_read_file(3),
vf_write_file(3),
vf_get_next_object(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_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)