Interface nsIWindowsRegKeyType

This interface is designed to provide scriptable access to the Windows registry system ("With Great Power Comes Great Responsibility"). The interface represents a single key in the registry.

This interface is highly Win32 specific.

Hierarchy

nsISupportsType
- nsIWindowsRegKeyType

Properties

`Readonly` childCount

childCount: number

This attribute returns the number of child keys.

key

key: HKEY

This attribute exposes the native HKEY and is available to provide C++ consumers with the flexibility of making other Windows registry API calls that are not exposed via this interface.

It is possible to initialize this object by setting an HKEY on it. In that case, it is the responsibility of the consumer setting the HKEY to ensure that it is a valid HKEY.

WARNING: Setting the key does not close the old key.

`Readonly` valueCount

valueCount: number

This attribute returns the number of values under this key.

Methods

AddRef

AddRef(): number
Increases the reference count for this interface. The associated instance will not be deleted unless the reference count is returned to zero.

Returns
The resulting reference count.

Returns number

Inherited from nsISupportsType.AddRef

QueryInterface

QueryInterface(aIID: object, aInstancePtr?: object): any
Parameters
- aIID: object
- Optional aInstancePtr: object
Returns any

Inherited from nsISupportsType.QueryInterface
QueryInterface(aIID: object, aInstancePtr: object): void
A run time mechanism for interface discovery.

Returns
NS_OK if the interface is supported by the associated instance, NS_NOINTERFACE if it is not.

aInstancePtr must not be null.
Parameters
- aIID: object
  
  [in] A requested interface IID
- aInstancePtr: object
  
  [out] A pointer to an interface pointer to receive the result.
Returns void

Inherited from nsISupportsType.QueryInterface

Release

Release(): number
Decreases the reference count for this interface. Generally, if the reference count returns to zero, the associated instance is deleted.

Returns
The resulting reference count.

Returns number

Inherited from nsISupportsType.Release

close

close(): void
This method closes the key. If the key is already closed, then this method does nothing.

Returns void

create

create(rootKey: number, relPath: string, mode: number): void
This method opens an existing key or creates a new key.

NOTE: On 32-bit Windows, it is valid to pass any HKEY as the rootKey parameter of this function. However, for compatibility with 64-bit Windows, that usage should probably be avoided in favor of createChild.
Parameters
- rootKey: number
  
  A root key defined above or any valid HKEY on 32-bit Windows.
- relPath: string
  
  A relative path from the given root key.
- mode: number
  
  Access mode, which is a bit-wise OR of the ACCESS_ values defined above.
Returns void

createChild

createChild(relPath: string, mode: number): nsIWindowsRegKey
This method opens or creates a subkey relative to this key.

Returns
nsIWindowsRegKey for the newly opened or created subkey.
Parameters
- relPath: string
- mode: number
Returns nsIWindowsRegKey

getChildName

getChildName(index: number): string
This method returns the name of the n'th child key.
Parameters
- index: number
  
  The index of the requested child key.
Returns string

getValueName

getValueName(index: number): string
This method returns the name of the n'th value under this key.
Parameters
- index: number
  
  The index of the requested value.
Returns string

getValueType

getValueType(name: string): number
This method returns the type of the value with the given name. The return value is one of the "TYPE_" constants defined above.
Parameters
- name: string
  
  The name of the value to query.
Returns number

hasChanged

hasChanged(): boolean
This method returns true if the key has changed and false otherwise. This method will always return false if startWatching was not called.

Returns boolean

hasChild

hasChild(name: string): boolean
This method checks to see if the key has a child by the given name.
Parameters
- name: string
  
  The name of the requested child key.
Returns boolean

hasValue

hasValue(name: string): boolean
This method checks to see if the key has a value by the given name.
Parameters
- name: string
  
  The name of the requested value.
Returns boolean

isWatching

isWatching(): boolean
This method returns true if the key is being watched for changes (i.e., if startWatching() was called).

Returns boolean

open

open(rootKey: number, relPath: string, mode: number): void
This method opens an existing key. This method fails if the key does not exist.

NOTE: On 32-bit Windows, it is valid to pass any HKEY as the rootKey parameter of this function. However, for compatibility with 64-bit Windows, that usage should probably be avoided in favor of openChild.
Parameters
- rootKey: number
  
  A root key defined above or any valid HKEY on 32-bit Windows.
- relPath: string
  
  A relative path from the given root key.
- mode: number
  
  Access mode, which is a bit-wise OR of the ACCESS_ values defined above.
Returns void

openChild

openChild(relPath: string, mode: number): nsIWindowsRegKey
This method opens a subkey relative to this key. This method fails if the key does not exist.

Returns
nsIWindowsRegKey for the newly opened subkey.
Parameters
- relPath: string
- mode: number
Returns nsIWindowsRegKey

readBinaryValue

readBinaryValue(name: string): string
This method reads the binary contents of the named value under this key.

JavaScript callers should take care with the result of this method since it will be byte-expanded to form a JS string. (The binary data will be treated as an ISO-Latin-1 character string, which it is not).
Parameters
- name: string
  
  The name of the value to query.
Returns string

readInt64Value

readInt64Value(name: string): number
This method reads the 64-bit integer contents of the named value.
Parameters
- name: string
  
  The name of the value to query.
Returns number

readIntValue

readIntValue(name: string): number
This method reads the integer contents of the named value.
Parameters
- name: string
  
  The name of the value to query.
Returns number

readStringValue

readStringValue(name: string): string
This method reads the string contents of the named value as a Unicode string.
Parameters
- name: string
  
  The name of the value to query. This parameter can be the empty string to request the key's default value.
Returns string

removeChild

removeChild(relPath: string): void
This method removes a child key and all of its values. This method will fail if the key has any children of its own.
Parameters
- relPath: string
  
  The relative path from this key to the key to be removed.
Returns void

removeValue

removeValue(name: string): void
This method removes the value with the given name.
Parameters
- name: string
  
  The name of the value to be removed.
Returns void

startWatching

startWatching(recurse: boolean): void
This method starts watching the key to see if any of its values have changed. The key must have been opened with mode including ACCESS_NOTIFY. If recurse is true, then this key and any of its descendant keys are watched. Otherwise, only this key is watched.
Parameters
- recurse: boolean
  
  Indicates whether or not to also watch child keys.
Returns void

stopWatching

stopWatching(): void
This method stops any watching of the key initiated by a call to startWatching. This method does nothing if the key is not being watched.

Returns void

writeBinaryValue

writeBinaryValue(name: string, data: string): void
This method writes the binary contents of the named value. The value will be created if it does not already exist.

JavaScript callers should take care with the value passed to this method since it will be truncated from a JS string (unicode) to a ISO-Latin-1 string. (The binary data will be treated as an ISO-Latin-1 character string, which it is not). So, JavaScript callers should only pass character values in the range \u0000 to \u00FF, or else data loss will occur.
Parameters
- name: string
  
  The name of the value to modify.
- data: string
  
  The data for the value to modify.
Returns void

writeInt64Value

writeInt64Value(name: string, data: number): void
This method writes the 64-bit integer contents of the named value. The value will be created if it does not already exist.
Parameters
- name: string
  
  The name of the value to modify.
- data: number
  
  The data for the value to modify.
Returns void

writeIntValue

writeIntValue(name: string, data: number): void
This method writes the integer contents of the named value. The value will be created if it does not already exist.
Parameters
- name: string
  
  The name of the value to modify.
- data: number
  
  The data for the value to modify.
Returns void

writeStringValue

writeStringValue(name: string, data: string): void
This method writes the unicode string contents of the named value. The value will be created if it does not already exist.
Parameters
- name: string
  
  The name of the value to modify. This parameter can be the empty string to modify the key's default value.
- data: string
  
  The data for the value to modify.
Returns void

Interface nsIWindowsRegKeyType

Hierarchy

Index

Properties

Methods

Properties

Readonly childCount

key

Readonly valueCount

Methods

AddRef

Returns

Returns number

QueryInterface

Parameters

aIID: object

Optional aInstancePtr: object

Returns any

Returns

Parameters

aIID: object

aInstancePtr: object

Returns void

Release

Returns

Returns number

close

Returns void

create

Parameters

rootKey: number

relPath: string

mode: number

Returns void

createChild

Returns

Parameters

relPath: string

mode: number

Returns nsIWindowsRegKey

getChildName

Parameters

index: number

Returns string

getValueName

Parameters

index: number

Returns string

getValueType

Parameters

name: string

Returns number

hasChanged

Returns boolean

hasChild

Parameters

name: string

Returns boolean

hasValue

Parameters

name: string

Returns boolean

isWatching

Returns boolean

open

Parameters

rootKey: number

relPath: string

mode: number

Returns void

openChild

Returns

Parameters

relPath: string

mode: number

Returns nsIWindowsRegKey

readBinaryValue

Parameters

name: string

Returns string

`Readonly` childCount

`Readonly` valueCount

`Optional` aInstancePtr: object