Note: This API documentation is for FAKE version 4. The migration API documentation can be found here. The API documentation for the new fake 5 modules can be found here

RegistryHelper

Contains functions which allow to read and write information from/to the registry.

Nested types and modules

TypeDescription
RegistryBaseKey

Registry base keys.

Functions and values

Function or valueDescription
createRegistrySubKey baseKey subKey
Signature: baseKey:RegistryBaseKey -> subKey:string -> unit

Create a registry subKey

deleteRegistrySubKey baseKey subKey
Signature: baseKey:RegistryBaseKey -> subKey:string -> unit

Deletes a registry subKey

deleteRegistryValue baseKey subKey name
Signature: baseKey:RegistryBaseKey -> subKey:string -> name:string -> unit

Deletes the registry value from its key

getRegistryKey(...)
Signature: baseKey:RegistryBaseKey -> subKey:string -> writePermission:bool -> RegistryKey

Gets a registry key and falls back to 32 bit if the 64bit key is not there

getRegistryKey64(...)
Signature: baseKey:RegistryBaseKey -> subKey:string -> writePermission:bool -> RegistryKey

Gets a 64-bit registry key

getRegistrySubKeyNames baseKey subKey
Signature: baseKey:RegistryBaseKey -> subKey:string -> string []

Returns all the subKey names of a registry key

getRegistryValue baseKey subKey name
Signature: baseKey:RegistryBaseKey -> subKey:string -> name:string -> string

Gets a registry value as string

getRegistryValue64 baseKey subKey name
Signature: baseKey:RegistryBaseKey -> subKey:string -> name:string -> string

Gets a registry value as string

getRegistryValueNames baseKey subKey
Signature: baseKey:RegistryBaseKey -> subKey:string -> string []

Returns all the value names of a registry key

setRegistryValue(...)
Signature: baseKey:RegistryBaseKey -> subKey:string -> name:string -> value:'T -> unit
Type parameters: 'T

Sets a registry value

valueExistsForKey baseKey subKey name
Signature: baseKey:RegistryBaseKey -> subKey:string -> name:string -> bool

Returns whether or not a registry value name exists for a key