Function

CFPropertyListWrite(_:_:_:_:_:)

Write the bytes of a serialized property list out to a stream.

Declaration

func CFPropertyListWrite(_ propertyList: CFPropertyList!, _ stream: CFWriteStream!, _ format: CFPropertyListFormat, _ options: CFOptionFlags, _ error: UnsafeMutablePointer<Unmanaged<CFError>?>!) -> CFIndex

Parameters

propertyList

The property list to write out.

stream

The CFWriteStream to which to write the data. The stream must be opened and configured.

format

A CFPropertyListFormat constant to specify the data format. See CFPropertyListFormat for possible values.

options

This parameter is currently unused and should be set to 0.

error

If this parameter is non-NULL, if an error occurs, on return this will contain a CFError error describing the problem. Ownership follows the The Create Rule.

Return Value

The number of bytes written to stream. If an error occurs, returns 0.

See Also

Exporting a Property List