Function

SKIndexCopyDocumentRefsForDocumentIDs(_:_:_:_:)

Gets document URL objects (of type SKDocument) based on document IDs.

Declaration

func SKIndexCopyDocumentRefsForDocumentIDs(_ inIndex: SKIndex!, _ inCount: CFIndex, _ inDocumentIDsArray: UnsafeMutablePointer<SKDocumentID>!, _ outDocumentRefsArray: UnsafeMutablePointer<Unmanaged<SKDocument>?>!)

Parameters

inIndex

The index containing the document information.

inCount

The number of document IDs in inDocumentIDsArray.

inDocumentIDsArray

Points to an array of document IDs corresponding to the document URL objects (of type SKDocument) you want.

outDocumentRefsArray

On input, a pointer to an array for document URL objects. On output, points to the previously allocated array, which now contains document URL objects corresponding to the document IDs in inDocumentIDsArray.

When finished with the document URL objects array, dispose of it by calling CFRelease on each array element.

Discussion

The SKIndexCopyDocumentRefsForDocumentIDs(_:_:_:_:) function lets you get a batch of document URL objects (of type SKDocument) in one step, based on a list of document IDs.

If you want to get lightweight URLs in the form of CFURL objects instead, use SKIndexCopyDocumentURLsForDocumentIDs(_:_:_:_:).

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 SKIndexCopyDocumentIDArrayForTermID(SKIndex!, CFIndex) -> Unmanaged<CFArray>!

Obtains document IDs for documents that contain a given term.

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.