xHarbour Reference Documentation > Function Reference

CFTSOpen()

Opens a Full Text Search index file.

Syntax

CFTSOpen( <cFileName>  , ;
          <nBufferSize>, ;
          <nOpenMode>    ) --> nFileHandle

Arguments

<cFileName>

This is a character string holding the name of the Full Text Search index file to open. It must include path and file extension. If the path is omitted from <cFileName>, the file is searched in the current directory. If no file extension is given, the extension .HSX is used.

<nBufferSize>

This is a numeric value specifying the memory buffer size in kB to be used by other CFTS_*() functions for this file (the value 10 means 10240 bytes).

<nOpenMode>

This numeric parameter specifies how the Full Text Search index file is opened. Possible values for <nOpenMode> are:

Open modes for Full Text Search index files

Value	Description
0	READ-WRITE + SHARED
1	READ-WRITE + EXCLUSIVE
2	READ-ONLY + SHARED
3	READ-ONLY + EXCLUSIVE4

Return

The function returns a numeric value greater or equal to zero when the Full Text Search index file can be opened. This value is a handle to the Full Text Search index file and must be used with other CFTS_*() functions.

A negative return value indicates an error condition.

Description

CFTSOpen() is a synonym for function HS_Open(). Refer to HS_Open() for more information.

Info

See also:	HS_Add(), HS_Close(), HS_Create(), HS_Next(), HS_Set()
Category:	CFTS functions
Source:	rdd\hsx\cftsfunc.c
LIB:	lib\xhb.lib
DLL:	dll\xhbdll.dll