Contents

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