SKIndexGetDocumentCount(_:)

Declaration

func SKIndexGetDocumentCount(_ inIndex: SKIndex!) -> CFIndex

Parameters

• inIndex:

  The index whose document URL objects (of type Skdocument) you want to count.

Return Value

A CFIndex object containing the number of document URL objects (of type SKDocument) in the index. On failure, returns 0.

Discussion

Document URL objects (of type SKDocument) added to an index have an indexing state of kSKDocumentStateIndexed. See the SKDocumentIndexState enumeration.

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.

Special Considerations

In the current implementation of Search Kit, SKIndexGetDocumentCount returns the number of documents represented in the on-disk index. If your application has added document URL objects to the index but has not yet called SKIndexFlush(_:), the document count may not be correct.

See Also

Managing Indexes

• SKIndexAddDocumentWithText(_:_:_:_:)
• SKIndexAddDocument(_:_:_:_:)
• SKIndexFlush(_:)
• SKIndexCompact(_:)
• SKIndexGetMaximumDocumentID(_:)
• SKIndexGetMaximumTermID(_:)
• SKIndexDocumentIteratorCreate(_:_:)
• SKIndexDocumentIteratorCopyNext(_:)
• SKIndexDocumentIteratorGetTypeID()
• SKIndexGetAnalysisProperties(_:)
• SKIndexMoveDocument(_:_:_:)
• SKIndexRemoveDocument(_:_:)
• SKIndexRenameDocument(_:_:_:)
• SKIndexSetMaximumBytesBeforeFlush(_:_:)
• SKIndexGetMaximumBytesBeforeFlush(_:)