SKIndexCopyDocumentProperties(_:_:)

Declaration

func SKIndexCopyDocumentProperties(_ inIndex: SKIndex!, _ inDocument: SKDocument!) -> Unmanaged<CFDictionary>!

Parameters

• inIndex:

  The index containing the document URL object whose properties you want to copy.

• inDocument:

  The document URL object whose properties you want to copy.

Return Value

A CFDictionary object containing the document URL object’s (SKDocumentRef’s) properties, or NULL on failure.

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 add a properties dictionary to a document URL object, and this function to obtain a copy of the dictionary.

See Also

Working with Documents and Terms

• SKDocumentCreateWithURL(_:)
• SKDocumentCreate(_:_:_:)
• SKDocumentCopyURL(_:)
• SKDocumentGetName(_:)
• SKDocumentGetParent(_:)
• SKDocumentGetSchemeName(_:)
• SKDocumentGetTypeID()
• SKIndexCopyDocumentForDocumentID(_:_:)
• SKIndexCopyInfoForDocumentIDs(_:_:_:_:_:)
• SKIndexCopyDocumentRefsForDocumentIDs(_:_:_:_:)
• SKIndexCopyDocumentURLsForDocumentIDs(_:_:_:_:)
• SKIndexCopyDocumentIDArrayForTermID(_:_:)
• SKIndexCopyTermIDArrayForDocumentID(_:_:)
• SKIndexCopyTermStringForTermID(_:_:)
• SKIndexGetTermIDForTermString(_:_:)
• SKIndexSetDocumentProperties(_:_:_:)
• SKIndexGetDocumentState(_:_:)
• SKIndexGetDocumentTermCount(_:_:)
• SKIndexGetDocumentTermFrequency(_:_:_:)
• SKIndexGetTermDocumentCount(_:_:)
• SKIndexGetDocumentID(_:_:)