Contents

SKIndexRenameDocument(_:_:_:)

Changes the name of a document URL object (of type Skdocument) in an index.

Declaration

func SKIndexRenameDocument(_ inIndex: SKIndex!, _ inDocument: SKDocument!, _ inNewName: CFString!) -> Bool

Parameters

  • inIndex:

    The index containing the document URL object whose name you want to change.

  • inDocument:

    The document URL object whose name you want to change.

  • inNewName:

    The new name for the document URL object.

Return Value

A Boolean value of true if the document URL object name was successfully changed, or false on failure.

Discussion

When your application changes the name of a document, use this function to update the index to reflect the change.

Search Kit is thread-safe. You can use separate indexing and searching threads. Your application is responsible for ensuring that no more than one process is open at a time for writing to an index.

See Also

Managing Indexes