Function

SKIndexCopyDocumentForDocumentID(_:_:)

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

Declaration

func SKIndexCopyDocumentForDocumentID(_ inIndex: SKIndex!, _ inDocumentID: SKDocumentID) -> Unmanaged<SKDocument>!

Parameters

inIndex

The index containing the document URL object.

inDocumentID

The ID of the document URL object you want to copy.

Return Value

A Search Kit document URL object.

Discussion

In versions of macOS prior to OS X v10.4, the parameter type for inDocumentID was CFIndex. The parameter type in macOS 10.4 and later is SKDocumentID.

See Also

Working with Documents and Terms

func SKDocumentCreateWithURL(CFURL!)

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

func SKDocumentCreate(CFString!, SKDocument!, CFString!)

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

func SKDocumentCopyURL(SKDocument!)

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

func SKDocumentGetName(SKDocument!)

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

func SKDocumentGetParent(SKDocument!)

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

func SKDocumentGetSchemeName(SKDocument!)

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

func SKDocumentGetTypeID()

Gets the type identifier for Search Kit document URL objects.

func SKIndexCopyDocumentIDArrayForTermID(SKIndex!, CFIndex)

Obtains document IDs for documents that contain a given term.

func SKIndexCopyTermIDArrayForDocumentID(SKIndex!, SKDocumentID)

Obtains the IDs for the terms of an indexed document.

func SKIndexCopyTermStringForTermID(SKIndex!, CFIndex)

Obtains a term, specified by ID, 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!)

Obtains the application-defined properties of an indexed document.

func SKIndexGetDocumentState(SKIndex!, SKDocument!)

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

func SKIndexGetDocumentTermCount(SKIndex!, SKDocumentID)

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

func SKIndexGetDocumentTermFrequency(SKIndex!, SKDocumentID, CFIndex)

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

func SKIndexGetTermDocumentCount(SKIndex!, CFIndex)

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

func SKIndexGetDocumentID(SKIndex!, SKDocument!)

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