xHarbour Reference Documentation > Function Reference

HS_Undelete()

Removes the deletion mark from an index entry in a HiPer-SEEK index file.

Syntax

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

Arguments

<nHsxHandle>

This is the numeric file handle of the HiPer-SEEK index file containing index entries marked as deleted. The file handle is returned from HS_Open() or HS_Create().

<nIndexEntry>

The ordinal position of the index entry to mark as undeleted must be specified as a numeric value.

Return

The function returns 1 when the deletion mark is successfully removed from the index entry, or a negative numeber indicating an error condition:

Error codes of HS_Undelete()

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.
-9	<nIndexEntry> is not marked for deletion.
-16	Invalid parameters are passed.
-18	Illegal HiPer-SEEK index file handle.

Description

HS_Undelete() removes the deletion mark from an index entry previously set with HS_Delete(). This is similar to DbDelete() and DbRecall().

Info

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