Function

SKDocumentGetTypeID()

Gets the type identifier for Search Kit document URL objects.

Declaration

func SKDocumentGetTypeID() -> CFTypeID

Return Value

A CFTypeID object containing the type identifier for the document URL object (of type SKDocument).

Discussion

Search Kit represents document URL objects with the SKDocument opaque type. If your code needs to determine whether a particular data type is a document URL object, you can use this function along with the CFGetTypeID(_:) function and perform a comparison.

Never hard-code the document URL object type ID because it can change from one release of macOS to another.

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 SKIndexCopyDocumentForDocumentID(SKIndex!, SKDocumentID)

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

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.