This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > ENSLIB namespace > %iFind.BitIterator


SQL Table Name: %iFind.BitIterator

Property Inventory

Method Inventory


property BitIndex as %Integer;
Property methods: BitIndexDisplayToLogical(), BitIndexGet(), BitIndexGetStored(), BitIndexIsValid(), BitIndexLogicalToDisplay(), BitIndexNormalize(), BitIndexSet()
property BitString as %String [ MultiDimensional ];
Property methods: BitStringDisplayToLogical(), BitStringGet(), BitStringIsValid(), BitStringLogicalToDisplay(), BitStringLogicalToOdbc(), BitStringNormalize(), BitStringSet()
property ChunkIndex as %Integer;
Property methods: ChunkIndexDisplayToLogical(), ChunkIndexGet(), ChunkIndexGetStored(), ChunkIndexIsValid(), ChunkIndexLogicalToDisplay(), ChunkIndexNormalize(), ChunkIndexSet()
property Finished as %Integer;
Property methods: FinishedDisplayToLogical(), FinishedGet(), FinishedGetStored(), FinishedIsValid(), FinishedLogicalToDisplay(), FinishedNormalize(), FinishedSet()
property Positions as %String [ MultiDimensional ];
Property methods: PositionsDisplayToLogical(), PositionsGet(), PositionsIsValid(), PositionsLogicalToDisplay(), PositionsLogicalToOdbc(), PositionsNormalize(), PositionsSet()


method %OnNew(ByRef pPos) as %Status
Inherited description: This callback method is invoked by the %New() method to provide notification that a new instance of an object is being created.

If this method returns an error then the object will not be created.

It is passed the arguments provided in the %New call. When customizing this method, override the arguments with whatever variables and types you expect to receive from %New(). For example, if you're going to call %New, passing 2 arguments, %OnNew's signature could be:

Method %OnNew(dob as %Date = "", name as %Name = "") as %Status If instead of returning a %Status code this returns an oref and this oref is a subclass of the current class then this oref will be the one returned to the caller of %New method.

method GetNext(moveToNext=0) as %Integer

Inherited Members

Inherited Methods


Storage Model: CacheStorage (%iFind.BitIterator)