Function

SKIndexDocumentIteratorGetTypeID()

Gets the type identifier for Search Kit document iterators.

Declaration

func SKIndexDocumentIteratorGetTypeID() -> CFTypeID

Return Value

A CFTypeID object containing the type identifier for the SKIndexDocumentIterator opaque type.

Discussion

Search Kit represents document iterators with the SKIndexDocumentIterator opaque type. If your code needs to determine whether a particular data type is a document iterator, you can use this function along with the CFGetTypeID(_:) function and perform a comparison.

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.

Never hard-code the document iterator type ID because it can change from one release of macOS to another.

See Also

Managing Indexes

func SKIndexAddDocumentWithText(SKIndex!, SKDocument!, CFString!, Bool)

Adds a document URL (SKDocument) object, and the associated document’s textual content, to an index.

func SKIndexAddDocument(SKIndex!, SKDocument!, CFString!, Bool)

Adds location information for a file-based document, and the document’s textual content, to an index.

func SKIndexFlush(SKIndex!)

Invokes all pending updates associated with an index and commits them to backing store.

func SKIndexCompact(SKIndex!)

Invokes all pending updates associated with an index, compacts the index if compaction is needed, and commits all changes to backing store.

func SKIndexGetDocumentCount(SKIndex!)

Gets the total number of documents represented in an index.

func SKIndexGetMaximumDocumentID(SKIndex!)

Gets the highest-numbered document ID in an index.

func SKIndexGetMaximumTermID(SKIndex!)

Gets the highest-numbered term ID in an index.

func SKIndexDocumentIteratorCreate(SKIndex!, SKDocument!)

Creates an index-based iterator for document URL objects (of type SKDocument) owned by a parent document URL object.

func SKIndexDocumentIteratorCopyNext(SKIndexDocumentIterator!)

Obtains the next document URL object (of type SKDocument) from an index using a document iterator.

func SKIndexGetAnalysisProperties(SKIndex!)

Gets the text analysis properties of an index.

func SKIndexMoveDocument(SKIndex!, SKDocument!, SKDocument!)

Changes the parent of a document URL object (of type SKDocument) in an index.

func SKIndexRemoveDocument(SKIndex!, SKDocument!)

Removes a document URL object (of type SKDocument) and its children, if any, from an index.

func SKIndexRenameDocument(SKIndex!, SKDocument!, CFString!)

Changes the name of a document URL object (of type SKDocument) in an index.

func SKIndexSetMaximumBytesBeforeFlush(SKIndex!, CFIndex)

Not recommended. Sets the memory size limit for updates to an index, measured in bytes.

func SKIndexGetMaximumBytesBeforeFlush(SKIndex!)

Not recommended. Gets the memory size limit for updates to an index, measured in bytes.