TDbWindow Class Reference

#include <d32dbms.h>

Link against: edbms.lib

class TDbWindow
Public Member Enumerations
enumanonymous { ENone }
enumTUnlimited { EUnlimited }
Public Member Functions
TDbWindow()
TDbWindow(TUnlimited)
TDbWindow(TInt, TInt)
TInt PreferredPos()
TInt Size()

Detailed Description

Describes the desired shape of a view's pre-evaluation window.

An instance of this class is passed to the RDbView object as part of the Prepare() function. The different constructors for TDbWindow can specify a view:

without pre-evaluation

with full pre-evaluation

with limited pre-evaluation.

See also: RDbView

Member Enumeration Documentation

Enum anonymous

EnumeratorValueDescription
ENone0

Enum TUnlimited

Denotes a full pre-evaluation window.

EnumeratorValueDescription
EUnlimitedKMaxTInt

No limit on how many rows may be in the window.

Constructor & Destructor Documentation

TDbWindow ( )

TDbWindow()[inline]

Constructs this object with a size of ENone. This can be used to request a view with no pre-evaluation window.

TDbWindow ( TUnlimited )

TDbWindow(TUnlimited)[inline]

Constructs this object with a size of EUnlimited. This is used to request a completely pre-evaluated view. The constant KDbUnlimitedWindow is an instance of such a TDbWindow.

TDbWindow ( TInt, TInt )

IMPORT_CTDbWindow(TIntaForeSlots,
TIntaRearSlots
)

Constructs this object with the preferred shape. When fully evaluated, the view will try to have aForeSlots rows immediately available for navigation forwards, and aRearSlots rows immediately available for navigation backwards.

ParameterDescription
aForeSlotsThe number of rows to evaluate ahead of the current row.
aRearSlotsThe number of rows to evaluate behind the current row.

Member Function Documentation

PreferredPos ( )

TInt PreferredPos()const [inline]

Returns the preferred position in the window of the current row marker. i.e. the position with the forward and backward slots as requested.

Returns: The preferred position in the window. It is undefined if this is not a limited window.

Size ( )

TInt Size()const [inline]

Returns the number of rows stored by the view.

Returns: The number of rows stored by the window. This could be one of the special values ENone or EUnlimited.