Initializer

init(contentsOfFile:usedEncoding:)

Returns an NSString object initialized by reading data from the file at a given path and returns by reference the encoding used to interpret the characters.

Declaration

convenience init(contentsOfFile path: String, usedEncoding enc: UnsafeMutablePointer<UInt>?) throws

Parameters

path

A path to a file.

enc

Upon return, if the file is read successfully, contains the encoding used to interpret the file at path. For possible values, see NSStringEncoding.

error

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

An NSString object initialized by reading data from the file named by path. The returned object may be different from the original receiver. If the file can’t be opened or there is an encoding error, returns nil.

Discussion

See Also

Related Symbols

stringWithContentsOfFile:encoding:error:

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

init(contentsOfFile: String, encoding: UInt)

Returns an NSString object initialized by reading data from the file at a given path using a given encoding.