Type Method


Archives an object graph rooted at a given object by encoding it into a data object then atomically writes the resulting data object to a file at a given path, and returns a Boolean value that indicates whether the operation was successful.


class func archiveRootObject(_ rootObject: Any, toFile path: String) -> Bool



The root of the object graph to archive.


The path of the file in which to write the archive.

Return Value

true if the operation was successful, otherwise false.


The format of the archive is NSPropertyListBinaryFormat_v1_0.

See Also

Archiving Data

class func archivedData(withRootObject: Any) -> Data

Returns an NSData object containing the encoded form of the object graph whose root object is given.

func finishEncoding()

Instructs the receiver to construct the final data stream.

var outputFormat: PropertyListSerialization.PropertyListFormat

The format in which the receiver encodes its data.

var requiresSecureCoding: Bool

Indicates whether the receiver requires all archived classes to conform to NSSecureCoding.

Beta Software

This documentation contains preliminary information about an API or technology in development. This information is subject to change, and software implemented according to this documentation should be tested with final operating system software.

Learn more about using Apple's beta software