xHarbour Reference Documentation > Function Reference

HS_KeyCount()

Returns the number of index entries in a HiPer-SEEK index file.

Syntax

HS_KeyCount( <nHsxHandle> ) --> nKeyCount

Arguments

<nHsxHandle>

This is the numeric file handle of the HiPer-SEEK index file to count the index entries in. The file handle is returned from HS_Open() or HS_Create().

Return

The function returns a numeric value greater or equal to zero representing the number of index entries contained in the HiPer-SEEK index. A negative value indicates an error condition:

Error codes of HS_KeyCount()

Value	Description
-16	Invalid parameter is passed.
-18	Illegal HiPer-SEEK index file handle.

Description

HS_KeyCount() is used to determine the total number of index entries available in a HiPer-SEEK index file.

Info

See also:	Hs_Filter(), OrdKeyCount()
Category:	Database functions , HiPer-SEEK functions , Index functions , xHarbour extensions
Source:	rdd\hsx\hsx.c
LIB:	lib\xhb.lib
DLL:	dll\xhbdll.dll