Function

SKIndexDocumentIteratorCopyNext

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

Declaration

SKDocumentRef SKIndexDocumentIteratorCopyNext(SKIndexDocumentIteratorRef inIterator);

Parameters

inIterator

The index-based document iterator. See SKIndexDocumentIteratorCreate for information on creating an document iterator, and SKIndexDocumentIteratorRef for more about iterators.

Return Value

The next document URL object in the index.

Discussion

This function returns NULL when there are no more document URL objects (of type SKDocumentRef) in the index. When finished iterating, your application must call CFRelease on all retrieved document URL objects that are non-NULL.

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.

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.

SKIndexDocumentIteratorGetTypeID

Gets the type identifier for Search Kit document iterators.

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.