Type Method


Creates and returns a property list by reading from the specified stream.


class func propertyList(with stream: InputStream, options opt: PropertyListSerialization.ReadOptions = [], format: UnsafeMutablePointer<PropertyListSerialization.PropertyListFormat>?) throws -> Any



An NSStream object. The stream should be open and configured for reading.


The options used to create the property list. For possible values, see PropertyListSerialization.MutabilityOptions.


Upon return, contains the format that the property list was stored in. Pass nil if you do not need to know the format.


If the method does not complete successfully, upon return contains an NSError object that describes the problem.

Return Value

A property list object corresponding to the representation in data. If data is not in a supported format, returns nil.


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