xHarbour Reference Documentation > Function Reference

HS_IfDel()

Checks if a HiPer-SEEK index entry is marked as deleted

Syntax

HS_IfDel( <nHsxHandle>, <nIndexEntry> ) --> nErrorCode

Arguments

<nHsxHandle>

This is the numeric file handle of the HiPer-SEEK index file to check. The file handle is returned from HS_Open() or HS_Create() !ELINK.

<nIndexEntry>

This is a numeric value specifying the ordinal position of the index entry to check.

Return

The function returns 1 when the index entry <nIndexEntry> is marked as deleted, zero when the deletion flag is not set, or a negative numeber indicating an error condition:

Error codes of HS_IfDel()

Value	Description
-4	Error while attempting to seek during buffer flushing.
-5	Read error while reading.
-6	Write error during buffer flushing.
-7	<nIndexEntry> is out of bounds.
-16	Invalid parameters are passed.
-18	Illegal HiPer-SEEK index file handle.

Description

HS_IfDel() checks if the deletion flag is set for an index entry in a HiPer-SEEK index file. This is analogous to the Deleted() function which tests if the current record is marked for deletion in a database file. The deletion flag in the HiPer-SEEK index is set with HS_Delete() and can be removed with HS_Undelete().

Info

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