xHarbour Reference Documentation > Function Reference

CFTSCrea()

Creates a new Full Text Search index file.

Syntax

CFTSCrea( <cFileName>       , ;
          <nBufferSize>     , ;
          <nKeySize>        , ;
          <lCaseInsensitive>, ;
          <nFilterSet>        ) --> nFileHandle

Arguments

<cFileName>

This is a character string holding the name of the Full Text Search index file to create. It must include path and file extension. If the path is omitted from <cFileName>, the file is created 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 CFTS_*() functions for this file (the value 10 means 10240 bytes).

<nKeySize>

An numeric value of 1, 2 or 3 must be passed. It defines the size of a single index entry in the Full Text Search index file. The larger <nKeySize> is, the more unique index entries can be stored, reducing the possibility of false positives when searching a Full Text Search index file. The size of an index entry is 16 bytes (1), 32 bytes (2) or 64 bytes (3).

<lCaseInsensitive>

This is a logical value. When .T. (true) is passed, the index is case insensitive, otherwise it is case sensitive.

<nFilterSet>

This is a numeric value of 1 or 2 defining the filter set to use with the Full Text Search index file. When <nFilterSet> is 1, all non-printable characters, such as Tab, or carriage return/line feed, are treated as blank spaces and the high-order bit is ignored for characters (7-bit character set).

Specifying 2 recognizes all characters by their ASCII value.

Return

The function returns a positive numeric value when the Full Text Search index file is successfully created. This is the handle to the new file, which must be used with other CFTS_*() functions. A negative value indicates an error.

Description

CFTSCrea() is a synonym for function HS_Create(). Refer to HS_Create() for more information.

Info

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