Returns a file handle initialized for reading the file, device, or named socket at the specified path.
SDKs
- iOS 2.0+
- macOS 10.0+
- Mac Catalyst 13.0+
- tvOS 9.0+
- watchOS 2.0+
Framework
- Foundation
Declaration
convenience init?(forReadingAtPath path: String)
Parameters
pathThe path to the file, device, or named socket to access.
Return Value
The initialized file handle object or nil if no file exists at path.
Discussion
The file pointer is set to the beginning of the file. You cannot write data to the returned file handle object. Use the read or read methods to read data from it.
When using this method to create a file handle object, the file handle owns its associated file descriptor and is responsible for closing it.