KeyType (Property)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

InfoThumbnailGeneration

KeyExpression (Example)

OperationLogDirectory

Password

PasswordProtected

PersistedCalculatedItem

RepeatableReadSupported

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

HFSQL properties

KeyType (Property)

In french: TypeClé

Available only with these kinds of connection

The KeyType property is used to set the characteristics of a key item. You can:

Determine if an item is key for an item defined in the data model editor or through programming
Define a key item (when the item is described through programming).

Versions 17 and later

This property is now available for iPhone/iPad applications.

New in version 17

This property is now available for iPhone/iPad applications.

Versions 18 and later

This property is now available in Windows Store apps mode.

New in version 18

This property is now available in Windows Store apps mode.

Versions 21 and later

This property is now available in Universal Windows 10 App mode.

New in version 21

This property is now available in Universal Windows 10 App mode.

Example

// Define the characteristics of the Orders.OrdID key
Orders.OrdID.KeyType = hUniqueKey
...
// Validate the data file description
HDescribeFile(Orders)

Syntax

Determining if an item is key Hide the details

<Characteristic> = <Data file>.<Item>.KeyType

<Characteristic>: Integer constant

The characteristics of an item are:
hDuplicatesKey Key with duplicates. This item can have the same value for several data file records.
hNotAKey The item is not a key.
hUniqueKey Unique key. The value assigned to this item will be unique in the data file. No file record will have the same value for this item.

<Data file>: Character string

Name of the data file used. This name was defined in the data model editor or with the File Description type.

<Item>: Character string

Name of the item used. This name was defined in the data model editor or with the Item Description type.

Defining a key through programming Hide the details

<Item>.KeyType = <Type of key>

<Item>: Character string

Name of the item used. This name was defined by the Item Description type.

<Type of key>: Integer constant

The characteristics of a key can be:
hDuplicatesKey Key with duplicates. This item can have the same value for several data file records.
hNotAKey The item is not a key.
hUniqueKey Unique key. The value assigned to this item will be unique in the data file. No file record will have the same value for this item.