Table_GetKeyInfo()

Examples


The Table_GetKeyInfo() function returns information about a key in the specified table.

Syntax

Table_GetKeyInfo(table_ID, key_number, duplicates, modifiable, compress, primary, index, unique, clustered)

Parameters

table_ID – An integer specifying the resource ID of the table for which key information will be returned.

key_number – An integer specifying a key in the table.

duplicates – A returned boolean indicating whether duplicates are allowed.

modifiable – A returned boolean indicating whether key fields are modifiable.

compress – A returned boolean indicating whether key values are compressed.

primary – A returned boolean indicating whether the key is the primary key for the table. This applies only to SQL tables.

index – A returned boolean indicating whether an index will be created for the table. This applies only to SQL tables.

unique – A returned boolean indicating whether the key values for each record in the table must be unique. This applies only to SQL tables.

clustered – A returned boolean indicating whether the key is a clustered key. This applies only to SQL tables.

Return value

The boolean value true.

Comments

This function does not work properly when used for third-party dictionaries that integrate with Microsoft Dynamics GP. It should be used only in the main product dictionary.


Documentation Feedback