vf_find_prop_qual

vf_find_prop_qual_index

Section: C Library Functions (3) Updated: 30 April 2003 Local index Up

NAME

vf_find_prop_qual_index - vf_find_prop_qual_index()

SYNOPSIS

#include <../vformat/vf_iface.h>

extern bool_t vf_find_prop_qual_index
(
       VF_PROP_T *p_prop,

       uint32_t *p_qualifier_index,

       uint32_t *p_found_value_index,

       const char **pp_possible_values,

       const char *p_token,

       vf_search_flags_t match

);

PARAMETERS

VF_PROP_T *p_prop: The property we're querying.
uint32_t *p_qualifier_index: Ptr to output name index.
uint32_t *p_found_value_index: Ptr to output index in array.
const char **pp_possible_values: Array of possible values.
const char *p_token: Token searched for.
vf_search_flags_t match: String comparison flags.

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.

RETURNS

TRUE iff found, FALSE else.

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)

This document was created by man2html, using the manual pages.
Time: 21:58:04 GMT, April 16, 2011