Adds a document URL (
SKDocument) object, and the associated document’s textual content, to an index.
- macOS 10.3+
- Core Services
The index to which you are adding the document URL object (
The document URL (
SKDocument) object to add.
The document text. Can be
A Boolean value specifying whether Search Kit will overwrite a document’s index entry (
true, indicated by
k), or retain the entry if it exists (
false, indicated by
A Boolean value of
true on success, or
false on failure. Also returns
false if the document has an entry in the index and
in is set to
Use this function to add the textual contents of arbitrary document types to an index. With this function, your application takes responsibility for getting textual content and handing it to the index as A
CFString object. Because of this, your application can define what it considers to be a document—a database record, a tagged field in an XML document, an object in memory, a text file, and so on.
Search Kit will index any size text string that you give it, up to its 4 GB index file size limit.
To add the textual content of file-based documents to a Search Kit index, you can use this function or take advantage of Search Kit’s ability to locate and read certain on-disk, file-based document types—see
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.
A single Search Kit index file can be up to 4 GB in size.
In OS X v10.3, some functions do not provide expected results unless you follow a call to
SKIndex with a call to
SKIndex. The affected functions include
SKIndex. However, in typical use this won’t be an issue, because applications call these functions after a search, and you must call
SKIndex before a search.