Generic record set.
More...
#include "C16/Records.hpp"
Generic record set.
- Examples
Iteration
void records_iterate(
Records& records)
{
for
(
)
{
...
}
}
◆ table()
const Table& C16::Records::table |
( |
| ) |
const |
Gets the table of the record set.
◆ record() [1/2]
const Record& C16::Records::record |
( |
| ) |
const |
◆ record() [2/2]
Record& C16::Records::record |
( |
| ) |
|
◆ reverse()
bool C16::Records::reverse |
( |
| ) |
const |
Gets if the order of the records is reverted.
◆ reverse_set()
void C16::Records::reverse_set |
( |
bool |
reverse | ) |
|
Sets if the order of the records is reverted.
- Parameters
-
reverse | Option to reverse the order of the records |
◆ count()
virtual long int C16::Records::count |
( |
| ) |
const |
|
pure virtual |
◆ read() [1/2]
Reads a record by means of a place into the record buffer.
- Parameters
-
place | Place of the record
Place::FIRST | Reads the first record of the record set. |
Place::LAST | Reads the last record of the record set. |
Place::NEXT | Reads the record following the record identified by the key value of the record buffer. |
Place::PREVIOUS | Reads the record preceding the record identified by the key value of the record buffer. |
|
locking | Locking to apply to the record
Locking::NONE | Does not change the lock of the record. |
Locking::LOCK_EXCLUSIVE | Applies an exclusive lock to the record. |
Locking::LOCK_SINGLE | Applies an exclusive, singulary lock to the record. |
Locking::LOCK_FORCE | Removes all locks by all users from the record and applies an exclusive lock to the record. |
Locking::LOCK_SHARED | Applies a shared lock to the record. |
Locking::UNLOCK | Removes a lock applied by the accessing user from the record. |
|
reverse | Option to use reverse order of the records |
- Returns
- Result
- Return values
-
- Exceptions
-
◆ read() [2/2]
Reads a record by means of its position into the record buffer.
- Parameters
-
position | Position of the record (1 to count()) |
locking | Locking to apply to the record
Locking::NONE | Does not change the lock of the record. |
Locking::LOCK_EXCLUSIVE | Applies an exclusive lock to the record. |
Locking::LOCK_SINGLE | Applies an exclusive, singulary lock to the record. |
Locking::LOCK_FORCE | Removes all locks by all users from the record and applies an exclusive lock to the record. |
Locking::LOCK_SHARED | Applies a shared lock to the record. |
Locking::UNLOCK | Removes a lock applied by the accessing user from the record. |
|
reverse | Option to use reverse order of the records |
- Returns
- Result
- Return values
-
- Exceptions
-