StringWithContentsOfFileEncodingError Method (path, enc, error)

Returns a string created by reading data from the file at a given path interpreted using a given encoding.

Original signature is '+ (id)stringWithContentsOfFile:(NSString *)path encoding:(NSStringEncoding)enc error:(NSError **)error'

Available in Mac OS X v10.4 and later.

Declaration Syntax

Visual Basic

Visual C++

public static NSString StringWithContentsOfFileEncodingError(
	NSString path,
	NSStringEncoding enc,
	out NSError error
)

Public Shared Function StringWithContentsOfFileEncodingError ( _
	path As NSString, _
	enc As NSStringEncoding, _
	<OutAttribute> ByRef error As NSError _
) As NSString

public:
static NSString^ StringWithContentsOfFileEncodingError(
	NSString^ path, 
	NSStringEncoding enc, 
	[OutAttribute] NSError^% error
)

Parameters

path (NSString): A path to a file.

enc (NSStringEncoding): The encoding of the file at path.

error (NSError%): If an error occurs, upon returns contains an NSError object that describes the problem. If you are not interested in possible errors, pass in NULL.

Return Value

A string created by reading data from the file named by path using the encoding, enc. If the file can’t be opened or there is an encoding error, returns nil.

Version Information

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

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