LPreferencesFile

LPreferencesFile is a PowerPlant class that is used for creating preferences files for your application.

Methods :

The methods in this class are:

LPreferencesFile()

OpenOrCreateResourceFork()

Data Members:

There are no data members for this class.

Operation:

This is a very simple class.

Source files:

(File & StreamClasses)

LPreferencesFile.h

LPreferencesFile.cp

Ancestors:

LFile

LPreferencesFile()

Purpose:

The constructors create objects from the passed-in values.

Access:

Public

Prototype:

LPreferencesFile();

LPreferencesFile( ConstStr255Param inFileName,

Boolean inCreateFolder);

LPreferencesFile( FSSpec& inFileSpec );

LPreferencesFile( AliasHandle inAlias,

Boolean& outWasChanged,

FSSpec* inFromFile );

The parameters for these constructors are:

ConstStr255Param	inFileName	The name of the file to create.
Boolean	inCreateFolder	This is passed to FindFolder().
FSSpec&	inFileSpec	The file spec for the file to use.
AliasHandle	inAlias	A handle to an alias to use.
Boolean	outWasChanged	Indicates if the AliasHandle was changed during resolution.
FSSpec*	inFromFile	A File Specifier for the starting point for a relative search. If nil, an absolute search is performed.

OpenOrCreateResourceFork()

Purpose:

.Opens the resource fork of the preferences file, if it exists. If the resource fork doesn't exist, it creates one. If the file doesn't exist, it creates the file with the designated type and creator codes.

Access:

Virtual, Public

Prototype:

virtual Int16 OpenOrCreateResourceFork( 

Int16 inPrivileges,

OSType inCreator,

OSType inFileType,

ScriptCode inScriptCode );

The parameters for these constructors are:

Int16	inPrivileges	The privileges to use.
OSType	inCreator	The creator type to use.
OSType	inFileType	The file type to use.
ScriptCode	inScriptCode	The script code to use.

Return:

Returns the RefNum of the resource fork for the file created.