Type Method

writePropertyList:toStream:format:options:error:

Writes a property list to the specified stream.

Declaration

+ (NSInteger)writePropertyList:(id)plist toStream:(NSOutputStream *)stream format:(NSPropertyListFormat)format options:(NSPropertyListWriteOptions)opt error:(out NSError * _Nullable *)error;

Parameters

plist

The property list that you want to write out.

stream

An NSOutputStream instance that is open and ready to receive the property list data.

format

One of the property list formats defined in NSPropertyListFormat.

opt

Currently unused. Set to 0.

error

A pointer that the function may set to an NSError object when an error occurs to provide additional information about the error.

Return Value

The number of bytes written to the stream. A return value of 0 indicates that an error occurred.

See Also

Serializing a Property List

+ dataWithPropertyList:format:options:error:

Returns an NSData object containing a given property list in a specified format.