Product Documentation

c-treeDB API for C++ - Developers Guide

Previous Topic

Next Topic

CTIndex::GetStatus

Retrieves the status of the index object.

Declaration

ULONG CTIndex::GetStatus() const;

Description

CTIndex::GetStatus() retrieves the status of a index object The status of the index object is a bit map describing one or more changes that have occurred to the index object.

Return

CTIndex::GetStatus() returns a bitmap of the following:

Value

Symbolic Constant

Explanation

0x00

CTDBINDEX_OLD

Original value (no changes)

0x01

CTDBINDEX_NEW

Index added

0x02

CTDBINDEX_DEL

Original Index deleted

0x04

CTDBINDEX_KEYTYPE

Index key type changed

0x10

CTDBINDEX_EMPCHAR

Index empty char changed

0x20

CTDBINDEX_DUPFLAG

Index duplicate flag changed

0x40

CTDBINDEX_NULLFLAG

Index null flag changed

0x80

CTDBINDEX_AIDXNAM

Index file name changed

Example


// if the index has been changed, call alter table

CTIndex hIndex = hTable.GetIndex(0);


if (hIndex.GetStatus() != CTDBINDEX_OLD)

if (hTable.Alter(CTDB_ALTER_NORMAL);

See Also

CTField::GetStatus(), CTSegment::GetStatus()

TOCIndex