WYRDTEK Home Features Reference Downloads About


Reference/es_mbb_mbm

Syntax

int es_mbb_mbm( struct es_mbb *fb, const char *fieldname, struct es_mbm *mfilter );

Arguments

struct es_mbb *fb Field-binding collection.
const char *fieldname Database field name.
struct es_mbm *mfilter Membership filter.

Return Codes

ES_ERROR_NONE Success. No errors.
ES_ERROR_INVALIDFIELDTYPE Database field is not an integer field ( i.e. 8, 16, 32 or 64bit field type)
ES_ERROR_UNKNOWNFIELD Unknown database field in this class.

Description

Bind a membership filter (struct es_mbm ) to an integer database field. This is required for filtered iteration across all the rows of a node using es_mbi_beginfetch()/es_mbi_incfetch() or es_mbs_beginfetch()/es_mbs_incfetch(). The iterator will skip rows that have particular values for that field depending on how the membership filter is set up.

[Back To Reference] [Back To Reference/es_mbb]