KI_DESCRIBE_KEY

Describe an index

Synopsis:
CALL KI_DESCRIBE_KEY handle, type$, path, SYM(buf$) TO status
status = 'ki_describe_key( handle, type$, path, SYM(buf$) )
ArgumentEnumerationPurpose
handleHandle
type$Index type "A" or "W"
pathPath
SYM(buf$)Symbol of buffer
statusKDB_ERROR_ENUMReturn status
>KI_WS_READ

KI_DESCRIBE_KEY

Returns a space separated list of column names which make up the segments of index path on the open handle. The index type can be either "A" for ordinary indices or "W" for word search indices.

If the supplied buffer is not large enough the output is truncated.

History
Introduced in KCML 6.00
See Also:
KI_DESCRIBE_SCHEMA, KI_EXTEND, KI_GET_COL_LIST, KI_SET_WLOCK_COUNT, KI_WMODE_BITMAP
KCML database status codes