mco_fh_mod_get_field_info

Return information (type, size, precision) about the specified table’s field.

Prototype

 
    mco_fh_ret mco_fh_mod_get_field_info(/*IN*/ mco_fh_module_h h, 
                            /*IN*/ const char *rec_type, 
                            /*IN*/ const char *field_name,
                            /*OUT*/ mco_int4 *type, 
                            /*OUT*/ mco_size_t *size, 
                            /*OUT*/ mco_size_t *precision)
 

Arguments

h The module handle
rec_type The type of the record containing the field
field_name The name of the field
type The returned field type (one of McoSql::tp* constants).
size The returned field size (for string fields only)
precision The returned field precision

Description

This function returns information (type, size, precision) about the specified table’s field.

Return Codes

MCO_FH_OK Metadata successfully returned
MCO_FH_E_NOT_IMPLEMENTED Force the Feed Handler application to call the module’s mco_fh_mod_fill_metadata() function to retrieve the types of fields configured by the user
MCO_FH_E_BAD_HANDLE The module handle is invalid
MCO_FH_E_INVALID_RECORD_TYPE The record type parameter is invalid, e.g. if the module does not recognize or support this record type
MCO_FH_E_INVALID_FIELD_NAME The field name parameter is invalid, e.g. the field name is not recognized, or cannot appear in the records of this type

Example

 
    mco_fh_ret mco_fh_mod_get_field_info(mco_fh_module_h h, const char *rec_type, 
                        const char *field_name, mco_int4 *type, 
                        mco_size_t *size, mco_size_t *precision)
    {
        return reinterpret_cast<TestFeedHandler *>(h)->getFieldInfo(rec_type, field_name, type, size, precision);
    }