xHarbour Reference Documentation > Function Reference

HS_Close()

Closes a HiPer-SEEK index file.

Syntax

HS_Close( <nHsxHandle> ) --> nErrorCode

Arguments

<nHsxHandle>

This is the numeric file handle of the HiPer-SEEK index file to add a new entry to. The file handle is returned from HS_Open() or HS_Create().

Return

The function returns a numeric value. Positive 1 indicates that the file is successfully closed, while negative numbers identify an error condition.

Error codes of HS_Close()

Value	Description
-4	Error while attempting to seek during buffer flushing.
-6	Write error during buffer flushing.
-16	Invalid parameters are passed.

Description

HS_Close() closes a HiPer-SEEK index file previously opened with HS_Create() or HS_Open(). This ensures that all memory buffers used are flushed to an index file before program termination.

Info

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