xHarbour Reference Documentation > Function Reference

HS_Set()

Defines a search string for subsequent HS_Next() calls.

Syntax

HS_Set( <nHsxHandle>, <cSearch> ) --> nIndexEntry

Arguments

<nHsxHandle>

This is the numeric file handle of the HiPer-SEEK index file to find <cSearch> in. The file handle is returned from HS_Open() or HS_Create().

<cSearch>

This is a character string holding the search string for subsequent HS_Next() calls.

Return

The function returns numeric 1 whan the search string is successfully defined, or a negative number as error code:

Error codes of HS_Set()

Value	Description
-4	Error while attempting to seek during buffer flushing.
-6	Write error during buffer flushing.
-13	HiPer-SEEK index file has no index entries.
-16	Invalid parameters are passed.
-18	Illegal HiPer-SEEK index file handle.

Description

HS_Set() defines the search string for a new Find operation in a HiPer-SEEK index file. The function prepares all internal parameters but dos not initiate a search. This must be accomplished with subsequent calls to the HS_Next() function which can be called repeatedly until no more matches are found.

Info

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