Function

SKDocumentGetParent

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

Declaration

SKDocumentRef SKDocumentGetParent(SKDocumentRef inDocument);

Parameters

inDocument

The document URL object whose parent you want to get.

Return Value

The parent document URL object, or NULL on failure.

Discussion

Search Kit manages document locations in terms of URLs as Document URL objects (of type SKDocumentRef). The parent document URL object typically contains the document’s URL up to but not including the document name.

Typically, document URL objects contain the complete URL to a file-based document. But you can use this function iteratively to build up the complete file-system path for a document that you are managing as part of a document hierarchy. See the description for the SKDocumentRef function for more on this.

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).

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.

SKIndexCopyDocumentRefsForDocumentIDs

Gets document URL objects (of type SKDocumentRef) 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.