Poco::Data

class Limit

Library: Data
Package: DataCore
Header: Poco/Data/Limit.h

Description

Limit stores information how many rows a query should return.

Member Summary

Member Functions: isHardLimit, isLowerLimit, operator !=, operator ==, value

Types

SizeT

typedef Poco::UInt32 SizeT;

Enumerations

Type

LIMIT_UNLIMITED = ~((SizeT)0)

Constructors

Limit

Limit(
    SizeT value,
    bool hardLimit = false,
    bool isLowerLimit = false
);

Creates the Limit.

Value contains the upper row hint, if hardLimit is set to true, the limit acts as a hard border, ie. every query must return exactly value rows, returning more than value objects will throw an exception! LowerLimits always act as hard-limits!

A value of LIMIT_UNLIMITED disables the limit.

Destructor

~Limit

~Limit();

Destroys the Limit.

Member Functions

isHardLimit inline

bool isHardLimit() const;

Returns true if the limit is a hard limit.

isLowerLimit inline

bool isLowerLimit() const;

Returns true if the limit is a lower limit, otherwise it is an upperLimit

operator != inline

bool operator != (
    const Limit & other
) const;

Inequality operator.

operator == inline

bool operator == (
    const Limit & other
) const;

Equality operator.

value inline

SizeT value() const;

Returns the value of the limit