DataWithPropertyListFormatOptionsError Method (plist, format, opt, error)

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

Original signature is '+ (NSData *)dataWithPropertyList:(id)plist 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 NSData DataWithPropertyListFormatOptionsError(
	Id plist,
	NSPropertyListFormat format,
	NSPropertyListMutabilityOptions opt,
	out NSError error
)

Public Shared Function DataWithPropertyListFormatOptionsError ( _
	plist As Id, _
	format As NSPropertyListFormat, _
	opt As NSPropertyListMutabilityOptions, _
	<OutAttribute> ByRef error As NSError _
) As NSData

public:
static NSData^ DataWithPropertyListFormatOptionsError(
	Id^ plist, 
	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. Passing nil for this value will cause an exception to be raised.

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

An NSData object containing plist in the format specified by format.

Version Information

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

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