Function

CFPropertyListWrite

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

Declaration

CFIndex CFPropertyListWrite(CFPropertyListRef propertyList, CFWriteStreamRef stream, CFPropertyListFormat format, CFOptionFlags options, CFErrorRef *error);

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

CFPropertyListCreateData

Returns a CFData object containing a serialized representation of a given property list in a specified format.

CFPropertyListCreateXMLData

Creates an XML representation of the specified property list.

Deprecated
CFPropertyListWriteToStream

Writes the bytes of a property list serialization out to a stream.

Deprecated