| API Reference | OSGeo FDO Provider for SHP |
ShpIScrollableFeatureReader Class Reference
#include <IScrollableFeatureReader.h>
Detailed Description
Definition at line 22 of file IScrollableFeatureReader.h.
Public Member Functions | ||||
| virtual int | Count ()=0 | |||
| Returns the number of records of the query result. | ||||
| virtual unsigned int | IndexOf (FdoPropertyValueCollection *key)=0 | |||
| Given a key of a feature, IndexOf will return the one based index or the record number of the feature within the returned query result. If the record is not found, then zero is retuned. This is the mirror function of the GetAtIndex function. This method does not affect the reader position. GetAtIndex need to be called to move the reader to the returned index. | ||||
| virtual bool | ReadAt (FdoPropertyValueCollection *key)=0 | |||
| provide the ad-hoc access to the query result. It positions the position of the reader at a given record defined by the key. If the record is not found, then the reader position is unset and false value is returned. Once the readers position becames unset, the caller needs to call ReadFirst, ReadLast or ReadAt to re-position the reader at a valid location.
| ||||
| virtual bool | ReadAtIndex (unsigned int recordindex)=0 | |||
| Provides an ad-hoc access to the query result. The recordindex is the one-based nth item in the query result. If successful, this method will position the reader at the feature identified by the recordindex. | ||||
| virtual bool | ReadFirst ()=0 | |||
| Position the reader at the first record of the query result. This method returns false if the query result is empty. | ||||
| virtual bool | ReadLast ()=0 | |||
| Position the reader at the last record of the query result. This method returns false if the query result is empty. | ||||
| virtual bool | ReadPrevious ()=0 | |||
| Advances the reader to the previous item and returns true if there is another object to read or false if reading is complete. The default position of the reader is prior to the first item. Therefore you must call ReadFirst or ReadLast to begin accessing any data. | ||||
The documentation for this class was generated from the following file:
| Comments? |