BtrieveBulkDeleteAttributes Class Reference

The Btrieve bulk delete attributes class. More...

#include <btrieveCpp.h>

Public Member Functions
	BtrieveBulkDeleteAttributes ()
	~BtrieveBulkDeleteAttributes ()
Btrieve::StatusCode	AddFilter (BtrieveFilter *btrieveFilter)
	Add a filter.
Btrieve::StatusCode	SetMaximumRecordCount (int maximumRecordCount)
	Set the maximum record count.
Btrieve::StatusCode	SetMaximumRejectCount (int maximumRejectCount)
	Set the maximum reject count.
Btrieve::StatusCode	SetSkipCurrentRecord (bool skipCurrentRecord)
	Set skip current record.

Detailed Description

The Btrieve bulk delete attributes class.

Constructor & Destructor Documentation

BtrieveBulkDeleteAttributes()

BtrieveBulkDeleteAttributes::BtrieveBulkDeleteAttributes

(

)

~BtrieveBulkDeleteAttributes()

BtrieveBulkDeleteAttributes::~BtrieveBulkDeleteAttributes

(

)

Member Function Documentation

AddFilter()

Btrieve::StatusCode BtrieveBulkDeleteAttributes::AddFilter

(

BtrieveFilter *

btrieveFilter

)

Add a filter.

Parameters

[in]

btrieveFilter

The filter.

Description

Delete bulk attributes have no filters initially.

Return values

= Btrieve::STATUS_CODE_NO_ERROR	Success.
!= Btrieve::STATUS_CODE_NO_ERROR	An error has occurred.

See also

Btrieve::StatusCodeToString

SetMaximumRecordCount()

Btrieve::StatusCode BtrieveBulkDeleteAttributes::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 or equal to Btrieve::MAXIMUM_BULK_RECORD_COUNT.

Description

Maximum record count defaults to zero.

Return values

= Btrieve::STATUS_CODE_NO_ERROR	Success.
!= Btrieve::STATUS_CODE_NO_ERROR	An error has occurred.

See also

Btrieve::StatusCodeToString

SetMaximumRejectCount()

Btrieve::StatusCode BtrieveBulkDeleteAttributes::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 Zen defined value.

Description

Maximum reject count defaults to the Zen defined value.

Return values

= Btrieve::STATUS_CODE_NO_ERROR	Success.
!= Btrieve::STATUS_CODE_NO_ERROR	An error has occurred.

See also

Btrieve::StatusCodeToString

SetSkipCurrentRecord()

Btrieve::StatusCode BtrieveBulkDeleteAttributes::SetSkipCurrentRecord

(

bool

skipCurrentRecord

)

Set skip current record.

Parameters

[in]

skipCurrentRecord

Skip current record?

Description

Skip current record is disabled by default.

Return values

= Btrieve::STATUS_CODE_NO_ERROR	Success.
!= Btrieve::STATUS_CODE_NO_ERROR	An error has occurred.

See also

Btrieve::StatusCodeToString