WYRDTEK Home Features Reference Downloads About


Reference/es_mba_addkey

Syntax

int es_mba_addkey( struct es_mba *agg, const char *fieldname );

Arguments

struct es_mba *agg Database aggregator.
const char *fieldname Database or formula field name.

Return Codes

ES_ERROR_NONE Success. No errors.
ES_ERROR_INVALIDFIELDTYPE fieldname is not an integer type.
ES_ERROR_FIELDEXISTS fieldname has already been specified as a key or result.
ES_ERROR_UNKNOWNFIELD fieldname is not a valid database or forumula field name.

Description

Specify a database or formula field to be used as part of the key used by the aggregator. A key field must be an integer and is added to form part of the index of the result class.

Formula fields defined to be keys must first be defined via es_mba_addformula().

[Back To Reference] [Back To Reference/es_mba]