ToC path:

mco_dict_nested_ifield

Return a nested field descriptor.

Prototype

 
    MCO_RET mco_dict_nested_ifield(	/*IN*/ mco_metadict_header_t * metadict, 
                      /*IN*/ unsigned short dict_no,
                      /*IN*/ unsigned short struct_no,
                      /*IN*/ unsigned short index_no, 
                      /*IN*/ unsigned short ifield_no,
                      /*OUT*/ mco_dict_nested_ifield_info_t * nested );

Arguments

metadict	The address of an initialized mco_metadict_header_t structure
dict_no	The number of the dictionary (must be between 0 and `mco_metadict_count()` - 1)
struct_no	The structure/class number (must be between 0 and `mco_dict_struct_count()` - 1)
index_no	The index number (must be between 0 and `struct_info.index_count` - 1)
ifield_no	The compound index field (segment) number (0 and `index_info.n_fields` - 1)
nested	The address of a `mco_dict_nested_ifield_info_t` variable to receive the compound index nested field descriptor

Description

This function returns a compound index field (segment) descriptor by the nested index field with number ifield_no.

Return Codes

MCO_S_OK	The field descriptor was successfully returned
MCO_E_UDA_DICT_NOTFOUND	The dictionary is not registered
MCO_E_UDA_STRUCT_NOTFOUND	Invalid `struct_no`
MCO_E_UDA_STRUCT_NOT_CLASS	Invalid `struct_no` (not a class)
MCO_E_UDA_INDEX_NOTFOUND	Invalid `index_no`
MCO_E_UDA_IFIELD_NOTFOUND	Invalid compound index field (segment) number `ifield_no`

Files

Header file:

mcouda.h

Source file:

mcouda.c

Library:

libmcouda.a