Function

SKDocumentCreate

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

Declaration

SKDocumentRef SKDocumentCreate(CFStringRef inScheme, SKDocumentRef inParent, CFStringRef inName);

Parameters

inScheme

The scheme to use—analogous to the scheme of a URL. Only documents referenced with the “file” scheme can be read by the SKIndexAddDocument function. The scheme can be anything you like if you use the SKIndexAddDocumentWithText function. The scheme can be NULL, in which case it will be set to be the same scheme as the document URL object’s parent. For more information on schemes, see http://www.iana.org/assignments/uri-schemes.html.

inParent

The document URL object one step up in the document hierarchy. Can be NULL.

inName

The name of the document that you’re creating a document URL object for. For the “file” scheme, it is the name of the file or the container, not its path. The path can be constructed by following parent links. The maximum length for a document name is 256 bytes.

Return Value

The new document URL object, or NULL on failure.

Discussion

The new document URL object’s parent can be NULL, but you must specify either a scheme or a parent. When your application no longer needs the document URL object, dispose of it by calling CFRelease.

See Also

Working with Documents and Terms

SKDocumentCreateWithURL

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

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.

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.