Function

SKIndexCopyDocumentIDArrayForTermID(_:_:)

Obtains document IDs for documents that contain a given term.

Declaration

func SKIndexCopyDocumentIDArrayForTermID(_ inIndex: SKIndex!, _ inTermID: CFIndex) -> Unmanaged<CFArray>!

Parameters

inIndex

The index to search.

inTermID

The ID of the term to search for.

Return Value

An array of CFNumbers, each the ID for a document URL object that points to a document containing the search term.

Discussion

SKIndexCopyDocumentIDArrayForTermID searches a single index for documents that contain a given term. The search uses a term ID, not a term string. To get the ID of a term, use SKIndexGetTermIDForTermString(_:_:).

Term IDs are index-specific; that is, a term has a different ID in each index in which it appears. If you want to search for all the documents containing a term in a set of indexes, call this function in turn for each index, using the index-specific term ID in each case.

See Also

Working with Documents and Terms

func SKDocumentCreateWithURL(CFURL!) -> Unmanaged<SKDocument>!

Creates a document URL object (of type SKDocument) from a CFURL object.

func SKDocumentCreate(CFString!, SKDocument!, CFString!) -> Unmanaged<SKDocument>!

Creates a document URL object (of type SKDocument) based on a scheme, parent, and name.

func SKDocumentCopyURL(SKDocument!) -> Unmanaged<CFURL>!

Builds a CFURL object from a document URL object (of type SKDocument).

func SKDocumentGetName(SKDocument!) -> Unmanaged<CFString>!

Gets the name of a document URL object (of type SKDocument).

func SKDocumentGetParent(SKDocument!) -> Unmanaged<SKDocument>!

Gets the parent of a document URL object (of type SKDocument).

func SKDocumentGetSchemeName(SKDocument!) -> Unmanaged<CFString>!

Gets the scheme name for a document URL object (of type SKDocument).

func SKDocumentGetTypeID() -> CFTypeID

Gets the type identifier for Search Kit document URL objects.

func SKIndexCopyDocumentForDocumentID(SKIndex!, SKDocumentID) -> Unmanaged<SKDocument>!

Obtains a document URL object (of type SKDocument) from an index.

func SKIndexSetDocumentProperties(SKIndex!, SKDocument!, CFDictionary!)

Sets the application-defined properties of a document URL object (of type SKDocument).

func SKIndexCopyDocumentProperties(SKIndex!, SKDocument!) -> Unmanaged<CFDictionary>!

Obtains the application-defined properties of an indexed document.

func SKIndexGetDocumentState(SKIndex!, SKDocument!) -> SKDocumentIndexState

Gets the current indexing state of a document URL object (of type SKDocument) in an index.

func SKIndexGetDocumentTermCount(SKIndex!, SKDocumentID) -> CFIndex

Gets the number of terms for a document in an index.

func SKIndexGetDocumentTermFrequency(SKIndex!, SKDocumentID, CFIndex) -> CFIndex

Gets the number of occurrences of a term in a document.

func SKIndexGetTermDocumentCount(SKIndex!, CFIndex) -> CFIndex

Gets the number of documents containing a given term represented in an index.

func SKIndexGetDocumentID(SKIndex!, SKDocument!) -> SKDocumentID

Gets the ID of a document URL object (of type SKDocument) in an index.