EngineKit
FileHelper Class Reference

#import <FileHelper.h>

Inheritance diagram for FileHelper:

Class Methods

(NSString *) + openTextFile:
 
(NSString *) + pathForFilename:
 

Detailed Description

A simple helper class used to facilitate file management.

Method Documentation

+ (NSString *) openTextFile: (NSString *)  filename

Opens a text file specified by the given filename, which is actually a path relative to the project folder.

Parameters
filenameThe path to the file, relative to the project foler.
Returns
An NSString with the file's contents.
+ (NSString *) pathForFilename: (NSString *)  filename

Used mostly internally by the FileHelper, returns a path to the file specified by the given filename, which should actually be a path relative to the project folder.. The path returned should be ready to be opened by system methods such as -stringWithContentsOfFile.

Parameters
filenameThe path to the file, relative to the project foler.
Returns
A path to the specified file.

The documentation for this class was generated from the following files: