Please note, this is a STATIC archive of website developer.mozilla.org from November 2016, cach3.com does not collect or store any user information, there is no "phishing" involved.

This interface is the main entry point into the back end preferences management library. The preference service is directly responsible for the management of the preferences files and also facilitates access to the preference branch object which allows the direct manipulation of the preferences themselves.
Inherits from: nsISupports Last changed in Gecko 1.7

Method overview

nsIPrefBranch getBranch(in string aPrefRoot);
nsIPrefBranch getDefaultBranch(in string aPrefRoot);
void readUserPrefs(in nsIFile aFile);
void resetPrefs();
void resetUserPrefs();
void savePrefFile(in nsIFile aFile);

Methods

getBranch()

Call to get a Preferences "Branch" which accesses user preference data. Using a Set method on this object will always create or set a user preference value. When using a Get method a user set value will be returned if one exists, otherwise a default value will be returned.

nsIPrefBranch getBranch(
  in string aPrefRoot
);
Parameters
aPrefRoot
The preference "root" on which to base this "branch". For example, if the root "browser.startup." is used, the branch will be able to easily access the preferences "browser.startup.page", "browser.startup.homepage", or "browser.startup.homepage_override" by simply requesting "page", "homepage", or "homepage_override". nsnull or "" may be used to access to the entire preference "tree".
Return value

nsIPrefBranch - The object representing the requested branch.

getDefaultBranch()

Call to get a Preferences "Branch" which accesses only the default preference data. Using a Set method on this object will always create or set a default preference value. When using a Get method a default value will always be returned.

Note: Few consumers will want to create default branch objects. Many of the branch methods do nothing on a default branch because the operations only make sense when applied to user set preferences.

nsIPrefBranch getDefaultBranch(
  in string aPrefRoot
);
Parameters
aPrefRoot
The preference "root" on which to base this "branch". For example, if the root "browser.startup." is used, the branch will be able to easily access the preferences "browser.startup.page", "browser.startup.homepage", or "browser.startup.homepage_override" by simply requesting "page", "homepage", or "homepage_override". nsnull or "" may be used to access to the entire preference "tree".
Return value

nsIPrefBranch - The object representing the requested default branch.

readUserPrefs()

Called to read in the preferences specified in a user preference file.

Note: If nsnull is passed in for the aFile parameter the default preferences file(s) [prefs.js, user.js] will be read and processed.

void readUserPrefs(
  in nsIFile aFile
);
Parameters
aFile
The file to be read.

resetPrefs()

Called to completely flush and re-initialize the preferences system.

void resetPrefs();
Parameters

None.

resetUserPrefs()

Called to reset all preferences with user set values back to the application default values.

void resetUserPrefs();
Parameters

None.

savePrefFile()

Called to write current preferences state to a file.

Note: If nsnull is passed in for the aFile parameter the preference data is written out to the current preferences file (usually prefs.js.)

void savePrefFile(
  in nsIFile aFile
);
Parameters
aFile
The file to be written.

See also

Document Tags and Contributors

Tags: 
 Contributors to this page: Sheppy, mnoorenberghe, Wjjohnst, trevorh, yecril71pl, Kglee
 Last updated by: Sheppy,