PropertyListWithStreamOptionsFormatError Method (stream, opt, format, error)

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

Original signature is '+ (id)propertyListWithStream:(NSInputStream *)stream options:(NSPropertyListReadOptions)opt format:(NSPropertyListFormat *)format error:(NSError **)error'

Available in Mac OS X v10.6 and later.

Declaration Syntax

Visual Basic

Visual C++

public static Id PropertyListWithStreamOptionsFormatError(
	NSInputStream stream,
	NSPropertyListMutabilityOptions opt,
	out NSPropertyListFormat format,
	out NSError error
)

Public Shared Function PropertyListWithStreamOptionsFormatError ( _
	stream As NSInputStream, _
	opt As NSPropertyListMutabilityOptions, _
	<OutAttribute> ByRef format As NSPropertyListFormat, _
	<OutAttribute> ByRef error As NSError _
) As Id

public:
static Id^ PropertyListWithStreamOptionsFormatError(
	NSInputStream^ stream, 
	NSPropertyListMutabilityOptions opt, 
	[OutAttribute] NSPropertyListFormat% format, 
	[OutAttribute] NSError^% error
)

Parameters

stream (NSInputStream): An NSStream object. The stream should be open and configured for reading.

opt (NSPropertyListMutabilityOptions): One of the “NSPropertyListMutabilityOptions” options.

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

error (NSError%): Upon return, contains the format that the property list was stored in.

Return Value

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

Version Information

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

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