Function

SKIndexCopyDocumentRefsForDocumentIDs

Gets document URL objects (of type SKDocumentRef) based on document IDs.

Declaration

void SKIndexCopyDocumentRefsForDocumentIDs(SKIndexRef inIndex, CFIndex inCount, SKDocumentID *inDocumentIDsArray, SKDocumentRef *outDocumentRefsArray);

Parameters

inIndex

The index containing the document information.

inCount

The number of document IDs in inDocumentIDsArray.

inDocumentIDsArray

Points to an array of document IDs corresponding to the document URL objects (of type SKDocumentRef) you want.

outDocumentRefsArray

On input, a pointer to an array for document URL objects. On output, points to the previously allocated array, which now contains document URL objects corresponding to the document IDs in inDocumentIDsArray.

When finished with the document URL objects array, dispose of it by calling CFRelease on each array element.

Discussion

The SKIndexCopyDocumentRefsForDocumentIDs function lets you get a batch of document URL objects (of type SKDocumentRef) in one step, based on a list of document IDs.

If you want to get lightweight URLs in the form of CFURL objects instead, use SKIndexCopyDocumentURLsForDocumentIDs.

See Also

Working with Documents and Terms

SKDocumentCreateWithURL

Creates a document URL object (of type SKDocumentRef) from a CFURLRef object.

SKDocumentCreate

Creates a document URL object (of type SKDocumentRef) based on a scheme, parent, and name.

SKDocumentCopyURL

Builds a CFURLRef object from a document URL object (of type SKDocumentRef).

SKDocumentGetName

Gets the name of a document URL object (of type SKDocumentRef).

SKDocumentGetParent

Gets the parent of a document URL object (of type SKDocumentRef).

SKDocumentGetSchemeName

Gets the scheme name for a document URL object (of type SKDocumentRef).

SKDocumentGetTypeID

Gets the type identifier for Search Kit document URL objects.

SKIndexCopyDocumentForDocumentID

Obtains a document URL object (of type SKDocumentRef) from an index.

SKIndexCopyInfoForDocumentIDs

Gets document names and parent IDs based on document IDs.

SKIndexCopyDocumentURLsForDocumentIDs

Gets document URLs based on document IDs.

SKIndexCopyDocumentIDArrayForTermID

Obtains document IDs for documents that contain a given term.

SKIndexCopyTermIDArrayForDocumentID

Obtains the IDs for the terms of an indexed document.

SKIndexCopyTermStringForTermID

Obtains a term, specified by ID, from an index.

SKIndexGetTermIDForTermString

Gets the ID for a term in an index.

SKIndexSetDocumentProperties

Sets the application-defined properties of a document URL object (of type SKDocumentRef).

SKIndexCopyDocumentProperties

Obtains the application-defined properties of an indexed document.

SKIndexGetDocumentState

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

SKIndexGetDocumentTermCount

Gets the number of terms for a document in an index.

SKIndexGetDocumentTermFrequency

Gets the number of occurrences of a term in a document.

SKIndexGetTermDocumentCount

Gets the number of documents containing a given term represented in an index.

SKIndexGetDocumentID

Gets the ID of a document URL object (of type SKDocumentRef) in an index.