Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes
nsIToolkitProfile Interface Reference

A interface representing a profile. More...

import "nsIToolkitProfile.idl";

Inheritance diagram for nsIToolkitProfile:
Inheritance graph
[legend]
Collaboration diagram for nsIToolkitProfile:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void remove (in boolean removeFiles)
 Removes the profile from the registry of profiles.
nsIProfileLock lock (out nsIProfileUnlocker aUnlocker)
 Lock this profile using platform-specific locking methods.

Public Attributes

readonly attribute nsILocalFile rootDir
 The location of the profile directory.
readonly attribute nsILocalFile localDir
 The location of the profile local directory, which may be the same as the root directory.
attribute AUTF8String name
 The name of the profile.

Detailed Description

A interface representing a profile.

Note:
THIS INTERFACE SHOULD BE IMPLEMENTED BY THE TOOLKIT CODE ONLY! DON'T EVEN THINK ABOUT IMPLEMENTING THIS IN JAVASCRIPT!

Definition at line 78 of file nsIToolkitProfile.idl.


Member Function Documentation

Lock this profile using platform-specific locking methods.

Parameters:
lockFileIf locking fails, this may return a lockFile object which can be used in platform-specific ways to determine which process has the file locked. Null may be passed.
Returns:
An interface which holds a profile lock as long as you reference it.
Exceptions:
NS_ERROR_FILE_ACCESS_DENIEDif the profile was already locked.

Removes the profile from the registry of profiles.

Parameters:
removeFilesIndicates whether or not the profile directory should be removed in addition.

Member Data Documentation

The location of the profile local directory, which may be the same as the root directory.

See nsIProfileLock::localDirectory.

Definition at line 89 of file nsIToolkitProfile.idl.

The name of the profile.

Definition at line 94 of file nsIToolkitProfile.idl.

The location of the profile directory.

Definition at line 83 of file nsIToolkitProfile.idl.


The documentation for this interface was generated from the following file: