Contents

SKIndexGetDocumentState(_:_:)

Gets the current indexing state of a document URL object (of type Skdocument) in an index.

Declaration

func SKIndexGetDocumentState(_ inIndex: SKIndex!, _ inDocument: SKDocument!) -> SKDocumentIndexState

Parameters

  • inIndex:

    The index containing the document URL object whose indexing state you want.

  • inDocument:

    The document URL object whose indexing state you want.

Return Value

A value indicating the document URL object’s indexing state.

Discussion

A document URL object (of type SKDocument) can be in one of four states, as defined by the SKDocumentIndexState enumeration: not indexed, indexed, not in the index but will be added after the index is flushed or closed, and in the index but will be deleted after the index is flushed or closed.

See Also

Working with Documents and Terms