Function

SKIndexSetDocumentProperties(_:_:_:)

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

Declaration

func SKIndexSetDocumentProperties(_ inIndex: SKIndex!, _ inDocument: SKDocument!, _ inProperties: CFDictionary!)

Parameters

inIndex

An index containing the document URL object whose properties you want to set.

inDocument

The document URL object whose properties you want to set.

inProperties

A CFDictionary object containing the properties to apply to the document URL object.

Discussion

Search Kit document URL objects (of type SKDocument) can have an optional, application-defined properties dictionary to hold any information you’d like to associate with the document represented by a document URL object—such as timestamp, keywords, and so on.

Use SKIndexSetDocumentProperties to persistently set application-defined properties for a document URL object in an index. This function replaces a document URL object’s existing properties dictionary with the new one. To obtain a copy of a document URL object’s properties dictionary, use SKIndexCopyDocumentProperties(_:_:).

Special Considerations

You must set any desired properties on a document URL object after adding the document URL object to an index. Adding a document URL object to an index clears the object’s preexisting properties.

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 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.