Contents

SKIndexCopyInfoForDocumentIDs(_:_:_:_:_:)

Gets document names and parent IDs based on document IDs.

Declaration

func SKIndexCopyInfoForDocumentIDs(_ inIndex: SKIndex!, _ inCount: CFIndex, _ inDocumentIDsArray: UnsafeMutablePointer<SKDocumentID>!, _ outNamesArray: UnsafeMutablePointer<Unmanaged<CFString>?>!, _ outParentIDsArray: UnsafeMutablePointer<SKDocumentID>!)

Parameters

  • inIndex:

    The index containing the document information.

  • inCount:

    The number of document IDs in inDocumentIDsArray.

  • inDocumentIDsArray:

    Points to an array of document IDs representing the documents whose names and parent IDs you want.

  • outNamesArray:

    On input, a pointer to an array for document names. On output, points to the previously allocated array, which now contains the document names corresponding to the document IDs in inDocumentIDsArray. May be NULL on input if you don’t want to get the document names.

    When finished with the names array, dispose of it by calling Cfrelease on each array element.

  • outParentIDsArray:

    On input, a pointer to an array for parent document IDs. On output, points to the previously allocated array, which now contains document IDs representing the parents of the documents whose IDs are in inDocumentIDsArray. May be NULL on input if you don’t want to get the parent document IDs.

Discussion

The SKIndexCopyInfoForDocumentIDs(_:_:_:_:_:) function lets you get a batch of document names and parent document IDs in one step, based on a list of document IDs.

See Also

Working with Documents and Terms