WritePropertyListToStreamFormatOptionsError Method (plist, stream, format, opt, error)

Writes the specified property list to the specified stream.

Original signature is '+ (NSInteger)writePropertyList:(id)plist toStream:(NSOutputStream *)stream format:(NSPropertyListFormat)format options:(NSPropertyListWriteOptions)opt error:(NSError **)error'

Available in Mac OS X v10.6 and later.

Declaration Syntax

Visual Basic

Visual C++

public static NSInteger WritePropertyListToStreamFormatOptionsError(
	Id plist,
	NSOutputStream stream,
	NSPropertyListFormat format,
	NSPropertyListMutabilityOptions opt,
	out NSError error
)

Public Shared Function WritePropertyListToStreamFormatOptionsError ( _
	plist As Id, _
	stream As NSOutputStream, _
	format As NSPropertyListFormat, _
	opt As NSPropertyListMutabilityOptions, _
	<OutAttribute> ByRef error As NSError _
) As NSInteger

public:
static NSInteger WritePropertyListToStreamFormatOptionsError(
	Id^ plist, 
	NSOutputStream^ stream, 
	NSPropertyListFormat format, 
	NSPropertyListMutabilityOptions opt, 
	[OutAttribute] NSError^% error
)

Parameters

plist (Id): A property list object. plist must be a kind of NSData, NSString, NSNumber, NSDate, NSArray, or NSDictionary object. Container objects must also contain only these kinds of objects.

stream (NSOutputStream): An NSStream. The stream should be open and configured for writing.

format (NSPropertyListFormat): A property list format. Possible values for format are described in NSPropertyListFormat.

opt (NSPropertyListMutabilityOptions): The opt parameter is currently unused and should be set to 0.

error (NSError%): If the method does not complete successfully, upon return contains an NSError object that describes the problem.

Return Value

Returns the number of bytes written to the stream. If the value is 0 an error occurred.

Version Information

Available in Monobjc Bridge: 10.6 (For Mac OS X 10.6 and later)

Assembly: Monobjc.Foundation (Module: Monobjc.Foundation)