ToC path:

mco_dict_event

Return an event descriptor.

Prototype

 
    MCO_RET mco_dict_event(	/*IN*/const mco_metadict_header_t * metadict, 
                  /*IN*/ unsigned short dict_no,
                  /*IN*/ unsigned short struct_no, 
                  /*IN*/ unsigned short event_no,
                  /*OUT*/ mco_dict_event_info_t * event_info );

Arguments

metadict	The address of a mco_metadict_header_t structure to initialize
dict_no	The index of the dictionary: must be between 0 and `mco_metadict_count().`
struct_no	The structure/class index (from 0 to `mco_dict_struct_count()` - 1)
event_no	The event number
event_info	The address of a `mco_dict_event_info_t` variable to receive the structure/class descriptor

Description

This function returns an event descriptor based on the dictionary number, class number and the DDL field name.

Return Codes

MCO_S_OK	The event 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_IFIELD_NOTFOUND	Invalid `name`

Files

Header file:

mcouda.h

Source file:

mcouda.c

Library:

libmcouda.a