Contents

SKDocumentCreate(_:_:_:)

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

Declaration

func SKDocumentCreate(_ inScheme: CFString!, _ inParent: SKDocument!, _ inName: CFString!) -> Unmanaged<SKDocument>!

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 1444897 Skindexadddocument function. The scheme can be anything you like if you use the 1444518 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 Link 1670302.

  • 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