WYRDTEK Home Features Reference Downloads About


Reference/es_mbi_begininit

Syntax

int es_mbi_begininit( struct es_mbi *iter, struct es_mbn *nd );

Arguments

struct es_mbi *iter Database node iterator.
struct es_mbn *nd Database node.

Return Codes

ES_ERROR_NONE Success. No errors.
ES_ERROR_INVALIDBINDING The field-binding associated with iter is for a class that is not the same (or a valid super class) as that of the node nd.
ES_ERROR_FAILTOFIND Database node nd is empty.

Description

Associate iterator with the node provided but dont update the iterator position. Requires a second call to es_mbi_incfetch() to advance the iterator to the first valid row in nd.

This function is useful in cases when its desirable only to use es_mbi_incfetch() to advance and fetch row-data, such as when there is no clear place in code to initialize and fetch the first row.

[Back To Reference] [Back To Reference/es_mbi]