The Btrieve bulk retrieve attributes class.
More...
#include <btrieveCpp.h>
The Btrieve bulk retrieve attributes class.
- Examples:
- bfilter.cpp, and btestbulk.cpp.
◆ BtrieveBulkRetrieveAttributes()
BtrieveBulkRetrieveAttributes::BtrieveBulkRetrieveAttributes |
( |
| ) |
|
◆ ~BtrieveBulkRetrieveAttributes()
BtrieveBulkRetrieveAttributes::~BtrieveBulkRetrieveAttributes |
( |
| ) |
|
◆ AddField()
◆ AddFilter()
Add a filter.
- Parameters
-
[in] | btrieveFilter | The filter. |
- Description
- Get bulk attributes have no filters initially.
- Snippet
- Return values
-
= Btrieve::STATUS_CODE_NO_ERROR | Success. |
!= Btrieve::STATUS_CODE_NO_ERROR | An error has occurred. |
- See also
- Btrieve::StatusCodeToString
- Examples:
- bfilter.cpp, and btestbulk.cpp.
◆ SetMaximumRecordCount()
Btrieve::StatusCode BtrieveBulkRetrieveAttributes::SetMaximumRecordCount |
( |
int |
maximumRecordCount | ) |
|
Set the maximum record count.
- Parameters
-
[in] | maximumRecordCount | The maximum record count. The maximum record count must be greater than 0 and less than 65536. |
- Description
- Maximum record count defaults to zero.
- Snippet
- Return values
-
= Btrieve::STATUS_CODE_NO_ERROR | Success. |
!= Btrieve::STATUS_CODE_NO_ERROR | An error has occurred. |
- See also
- Btrieve::StatusCodeToString
- Examples:
- bfilter.cpp, and btestbulk.cpp.
◆ SetMaximumRejectCount()
Btrieve::StatusCode BtrieveBulkRetrieveAttributes::SetMaximumRejectCount |
( |
int |
maximumRejectCount | ) |
|
Set the maximum reject count.
- Parameters
-
[in] | maximumRejectCount | The maximum reject count. The maximum reject count must be greater than or equal to 0 and less than 65536. A value of zero sets the maximum reject count to the PSQL defined value. |
- Description
- Maximum reject count defaults to the PSQL defined value.
- Snippet
- Return values
-
= Btrieve::STATUS_CODE_NO_ERROR | Success. |
!= Btrieve::STATUS_CODE_NO_ERROR | An error has occurred. |
- See also
- Btrieve::StatusCodeToString
- Examples:
- bfilter.cpp, and btestbulk.cpp.
◆ SetSkipCurrentRecord()
Btrieve::StatusCode BtrieveBulkRetrieveAttributes::SetSkipCurrentRecord |
( |
bool |
skipCurrentRecord | ) |
|
Set skip current record.
- Parameters
-
[in] | skipCurrentRecord | Skip current record? |
- Description
- Skip current record is disabled by default.
- Snippet
- Return values
-
= Btrieve::STATUS_CODE_NO_ERROR | Success. |
!= Btrieve::STATUS_CODE_NO_ERROR | An error has occurred. |
- See also
- Btrieve::StatusCodeToString
- Examples:
- bfilter.cpp, and btestbulk.cpp.