Structures > strKeySpec Structure

Purpose

KeySpec Structure is used when creating files to describe the keys

Prototype

STRUCTURE strKeySpec ALIGN 1

Description

The KeySpec structure is used when creating files. See the Btrieve API documentation for more information about the possible values in this structure.

Source Code

STRUCTURE strKeySpec ALIGN 1

MEMBER KeyPos AS WORD // Key Position

MEMBER KeyLen AS WORD // Key Length

MEMBER KeyFlags AS WORD // Index flags

MEMBER KeyTot AS DWORD // # of keys in segment

MEMBER KeyType AS BYTE // Key Type

MEMBER Null AS BYTE // Null allowed

MEMBER Reserved AS WORD

MEMBER KeyNumber AS BYTE

MEMBER ACSNumber AS BYTE

See Also

_BTCreate(), strFileSpec, BtSegMent

Notes

The KeyFlags field can contain the following values:

Attribute Binary Hex Dec VO Define

Duplicate 0000 0000 0001 01 1 BKF_DUP

Modifiable 0000 0000 0010 02 2 BKF_MOD

Binary 0000 0000 0100 04 4 BKF_BIN

Null Key (All-Segment) 0000 0000 1000 08 8 BKF_NUL

Segmented 0000 0001 0000 10 16 BKF_SEG

Alt Col Sequence 0000 0010 0000 20 32 BKF_ALT

Descending 0000 0100 0000 40 64 BKF_DESC

Repeating Duplicatable (v6.1) 0000 1000 0000 80 128 BKF_REPEAT_DUPS

Extended Type 0001 0000 0000 100 256 BKF_EXTTYPE

Null Key (Any-Segment) 0010 0000 0000 200 512 BKF_MANUAL

Case Insensitivity 0100 0000 0000 400 1,024 BKF_NOCASE