Function

SKIndexDocumentIteratorGetTypeID

Gets the type identifier for Search Kit document iterators.

Declaration

CFTypeID SKIndexDocumentIteratorGetTypeID(void);

Return Value

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

Discussion

Search Kit represents document iterators with the SKIndexDocumentIteratorRef 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

SKIndexAddDocumentWithText

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

SKIndexAddDocument

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

SKIndexFlush

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

SKIndexCompact

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

SKIndexGetDocumentCount

Gets the total number of documents represented in an index.

SKIndexGetMaximumDocumentID

Gets the highest-numbered document ID in an index.

SKIndexGetMaximumTermID

Gets the highest-numbered term ID in an index.

SKIndexDocumentIteratorCreate

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

SKIndexDocumentIteratorCopyNext

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

SKIndexGetAnalysisProperties

Gets the text analysis properties of an index.

SKIndexMoveDocument

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

SKIndexRemoveDocument

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

SKIndexRenameDocument

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

SKIndexSetMaximumBytesBeforeFlush

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

SKIndexGetMaximumBytesBeforeFlush

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