nsIWindowsShellService

browser/components/shell/public/nsIWindowsShellService.idlScriptable

Please add a summary to this article.

Inherits from: nsIShellService Last changed in Gecko 2.0 (Firefox 4 / Thunderbird 3.3 / SeaMonkey 2.1)

Method overview

string getRegistryEntry(in long aHKeyConstant, in string aSubKeyName, in string aValueName); Obsolete since Gecko 1.8

void restoreFileSettings(in boolean aForAllUsers); Obsolete since Gecko 1.9

void shortcutMaintenance();

Attribute	Type	Description
`desktopBackgroundColor`	`unsigned long`	The desktop background color, visible when no background image is used, or if the background image is centered and does not fill the entire screen. A rgb value, where (r << 24 \| g << 16 \| b) Obsolete since Gecko 1.8
`unreadMailCount`	`unsigned long`	The number of unread mail messages for the current user. Read only.

Valid starting keys for the Windows Registry.

Constant	Value	Description
`HKCR`	`0`	HKEY_CLASSES_ROOT. Obsolete since Gecko 1.8
`HKCC`	`1`	HKEY_CURRENT_CONFIG. Obsolete since Gecko 1.8
`HKCU`	`2`	HKEY_CURRENT_USER. Obsolete since Gecko 1.8
`HKLM`	`3`	HKEY_LOCAL_MACHINE. Obsolete since Gecko 1.8
`HKU`	`4`	HKEY_USERS. Obsolete since Gecko 1.8

Obsolete since Gecko 1.8 (Firefox 1.5 / Thunderbird 1.5 / SeaMonkey 1.0)

Retrieves a Windows Registry entry value.

string getRegistryEntry(
  in long aHKeyConstant,
  in string aSubKeyName,
  in string aValueName
);

aHKeyConstant: The starting key, using the constants defined above.
aSubKeyName: The sub key to locate.
aValueName: The value to locate in the sub key. The empty string returns the default value of the sub key.

The value of the specified sub key/value, truncated to 4096 bytes.

Obsolete since Gecko 1.9 (Firefox 3)

Restores system settings to what they were before Firefox modified them.

void restoreFileSettings(
  in boolean aForAllUsers 
);

aForAllUsers: Whether or not Firefox should restore settings for all users on a multi-user system.

Requires Gecko 2.0 (Firefox 4 / Thunderbird 3.3 / SeaMonkey 2.1)

Provides the shell service an opportunity to do some Win7+ shortcut maintenance needed on initial startup of the browser.

void shortcutMaintenance();

None.