Contents

SKIndexDocumentIteratorCreate(_:_:)

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

Declaration

func SKIndexDocumentIteratorCreate(_ inIndex: SKIndex!, _ inParentDocument: SKDocument!) -> Unmanaged<SKIndexDocumentIterator>!

Parameters

  • inIndex:

    The index you want to iterate across.

  • inParentDocument:

    The document URL object that is the parent of the document URL objects you want to examine. Pass NULL to get the top item in an index. See Skdocument for a discussion of how to get the full URL for a document URL object.

Return Value

An index-based document iterator.

Discussion

When you want to iterate across all the documents represented in an index, use this function to create an iterator and then call SKIndexDocumentIteratorCopyNext(_:) in turn for each document URL object (of type SKDocument) in the index.

Document iterators iterate over a single level of an index. Your code is responsible for descending through a hierarchy of documents in an index.

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 iterator, dispose of it by calling CFRelease.

See Also

Managing Indexes