Creates a named index in a file whose location is specified with a CFURL object.
- macOS 10.3+
- Core Services
The location of the index.
The name of the index. If you call this function with
NULL, Search Kit assigns the index the default index name
IADefault. If you then attempt to create a second index in the same file without assigning a name, no second index is created and this function returns
NULL. Search Kit does not currently support retrieving index names from an index.
The index type. See
The text analysis properties dictionary, which optionally sets the minimum term length, stopwords, term substitutions, maximum unique terms to index, and proximity support (for phrase-based searches) when creating the index. See Text Analysis Keys. To get the analysis properties of an index, use the
Get Analysis Properties(_:)
inparameter can be
NULL, in which case Search Kit applies the default dictionary, which is
A unique reference to the newly created index.
SKIndex creates an index in a file. Search Kit indexes are initially empty. Use this function when your application needs persistent storage of an index. To create a memory-based, nonpersistent index, use
A file can contain more than one index. To add a new index to an existing file, use the same value for
in and supply a new name for
Search Kit is thread-safe. You can use separate indexing and searching threads. Your application is responsible for ensuring that no more than one process is open at a time for writing to an index.
When your application no longer needs the index, dispose of it by calling
You cannot use