Function

SKDocumentGetParent(_:)

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

Declaration

func SKDocumentGetParent(_ inDocument: SKDocument!) -> Unmanaged<SKDocument>!

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 SKDocument). 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 SKDocument function for more on this.

See Also

Working with Documents and Terms

func SKDocumentCreateWithURL(CFURL!) -> Unmanaged<SKDocument>!

Creates a document URL object (of type SKDocument) from a CFURL object.

func SKDocumentCreate(CFString!, SKDocument!, CFString!) -> Unmanaged<SKDocument>!

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

func SKDocumentCopyURL(SKDocument!) -> Unmanaged<CFURL>!

Builds a CFURL object from a document URL object (of type SKDocument).

func SKDocumentGetName(SKDocument!) -> Unmanaged<CFString>!

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

func SKDocumentGetSchemeName(SKDocument!) -> Unmanaged<CFString>!

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

func SKDocumentGetTypeID() -> CFTypeID

Gets the type identifier for Search Kit document URL objects.

func SKIndexCopyDocumentForDocumentID(SKIndex!, SKDocumentID) -> Unmanaged<SKDocument>!

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

func SKIndexCopyDocumentIDArrayForTermID(SKIndex!, CFIndex) -> Unmanaged<CFArray>!

Obtains document IDs for documents that contain a given term.

func SKIndexSetDocumentProperties(SKIndex!, SKDocument!, CFDictionary!)

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

func SKIndexCopyDocumentProperties(SKIndex!, SKDocument!) -> Unmanaged<CFDictionary>!

Obtains the application-defined properties of an indexed document.

func SKIndexGetDocumentState(SKIndex!, SKDocument!) -> SKDocumentIndexState

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

func SKIndexGetDocumentTermCount(SKIndex!, SKDocumentID) -> CFIndex

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

func SKIndexGetDocumentTermFrequency(SKIndex!, SKDocumentID, CFIndex) -> CFIndex

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

func SKIndexGetTermDocumentCount(SKIndex!, CFIndex) -> CFIndex

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

func SKIndexGetDocumentID(SKIndex!, SKDocument!) -> SKDocumentID

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