Difference between revisions of "fcl-registry"

From Lazarus wiki
Jump to navigationJump to search
(Elevation)
m (Fixed syntax highlighting; typos; wiki markup)
Line 4: Line 4:
  
 
== Registry terms ==
 
== Registry terms ==
 +
 
RootKey: registry hive where you want to start accessing the registry. Examples: HKEY_LOCAL_MACHINE, HKEY_CURRENT_USER
 
RootKey: registry hive where you want to start accessing the registry. Examples: HKEY_LOCAL_MACHINE, HKEY_CURRENT_USER
  
 
Key: the path to the "directory" that contains individual data. This is a bit counter-intuitive but a holdover from compatibility with earlier versions of the registry.
 
Key: the path to the "directory" that contains individual data. This is a bit counter-intuitive but a holdover from compatibility with earlier versions of the registry.
  
Name/value: the actual name/value pairs in the Key "directory". Each key can have a default value, whose name is '' (an empty string.
+
Name/value: the actual name/value pairs in the Key "directory". Each key can have a default value, whose name is ''(an empty string)''.
  
 
== Example ==
 
== Example ==
 +
 
Example that tries to get a value:
 
Example that tries to get a value:
<syntaxhighlight>
+
 
 +
<syntaxhighlight lang=pascal>
 
uses ... registry...
 
uses ... registry...
  
Line 32: Line 35:
  
 
== Accessing 64 bit and 32 bit registry views ==
 
== Accessing 64 bit and 32 bit registry views ==
 +
 
If you have 64 bit Windows, the registry is split up into a 64 bit and 32 bit (compatibility) part. By default, if you run a 32 bit process, you see the 32 bit part; if you run a 64 bit application, you see the 64 bit part.
 
If you have 64 bit Windows, the registry is split up into a 64 bit and 32 bit (compatibility) part. By default, if you run a 32 bit process, you see the 32 bit part; if you run a 64 bit application, you see the 64 bit part.
  
You can also access the 32 bit part from 64 bit applications and vice versa. From MSDN:
+
You can also access the 32 bit part from 64 bit applications and vice versa. From [http://msdn.microsoft.com/en-us/library/windows/desktop/aa384129%28v=vs.85%29.aspx MSDN]
http://msdn.microsoft.com/en-us/library/windows/desktop/aa384129%28v=vs.85%29.aspx
+
 
 
* KEY_WOW64_64KEY: Access a 64-bit key from either a 32-bit or 64-bit application.
 
* KEY_WOW64_64KEY: Access a 64-bit key from either a 32-bit or 64-bit application.
 
* KEY_WOW64_32KEY: Access a 32-bit key from either a 32-bit or 64-bit application.
 
* KEY_WOW64_32KEY: Access a 32-bit key from either a 32-bit or 64-bit application.
 +
 
These keys are defined in the registry unit so you can just use them:
 
These keys are defined in the registry unit so you can just use them:
e.g. in the registry object's Access property, like this:
+
eg in the registry object's Access property, like this:
<syntaxhighlight>Registry := TRegistry.Create;
+
 
 +
<syntaxhighlight lang=pascal>
 +
Registry := TRegistry.Create;
 
Try
 
Try
 
   Registry.Access:=Registry.Access or KEY_WOW64_64KEY;
 
   Registry.Access:=Registry.Access or KEY_WOW64_64KEY;
 
</syntaxhighlight>
 
</syntaxhighlight>
  
or in the registry.create call, e.g.
+
or in the registry.create call, eg:
<syntaxhighlight>TRegistry.Create(KEY_READ or KEY_WOW64_64KEY);</syntaxhighlight>
+
 
 +
<syntaxhighlight lang=pascal>
 +
TRegistry.Create(KEY_READ or KEY_WOW64_64KEY);
 +
</syntaxhighlight>
  
 
== Administrative privileges ==
 
== Administrative privileges ==
Depending on what you want to read/write in the registry, you may need administrator rights and  elevation (Windows Vista+). Please see [[IDE_Window:_Project_Options#Use_manifest_file_to_set_execution_level_.28Windows_only.29]]
+
 
 +
Depending on what you want to read/write in the registry, you may need administrator rights and  elevation (Windows Vista+). Please see [[IDE_Window:_Project_Options#Use_manifest_file_to_set_execution_level_.28Windows_only.29|Use manifest file to set execution level]]
  
 
== See also ==
 
== See also ==
Line 56: Line 67:
 
[[Category:FCL]]
 
[[Category:FCL]]
 
[[Category:FPC]]
 
[[Category:FPC]]
 +
[[Category:Windows]]
 
[[Category:Standard Units]]
 
[[Category:Standard Units]]

Revision as of 23:51, 14 February 2020

English (en) español (es) русский (ru)

fcl-registry is an FCL unit that provides access to the Windows registry.

Registry terms

RootKey: registry hive where you want to start accessing the registry. Examples: HKEY_LOCAL_MACHINE, HKEY_CURRENT_USER

Key: the path to the "directory" that contains individual data. This is a bit counter-intuitive but a holdover from compatibility with earlier versions of the registry.

Name/value: the actual name/value pairs in the Key "directory". Each key can have a default value, whose name is (an empty string).

Example

Example that tries to get a value:

uses ... registry...

var
  CompileCommand: string='';
  Registry: TRegistry;
begin
  Registry := TRegistry.Create;
  try
    // Navigate to proper "directory":
    Registry.RootKey := HKEY_LOCAL_MACHINE;
    if Registry.OpenKeyReadOnly('\SOFTWARE\Classes\InnoSetupScriptFile\shell\Compile\Command') then
      CompileCommand:=Registry.ReadString(''); //read the value of the default name
  finally
    Registry.Free;
  end;
end;

Accessing 64 bit and 32 bit registry views

If you have 64 bit Windows, the registry is split up into a 64 bit and 32 bit (compatibility) part. By default, if you run a 32 bit process, you see the 32 bit part; if you run a 64 bit application, you see the 64 bit part.

You can also access the 32 bit part from 64 bit applications and vice versa. From MSDN

  • KEY_WOW64_64KEY: Access a 64-bit key from either a 32-bit or 64-bit application.
  • KEY_WOW64_32KEY: Access a 32-bit key from either a 32-bit or 64-bit application.

These keys are defined in the registry unit so you can just use them: eg in the registry object's Access property, like this:

Registry := TRegistry.Create;
Try
  Registry.Access:=Registry.Access or KEY_WOW64_64KEY;

or in the registry.create call, eg:

TRegistry.Create(KEY_READ or KEY_WOW64_64KEY);

Administrative privileges

Depending on what you want to read/write in the registry, you may need administrator rights and elevation (Windows Vista+). Please see Use manifest file to set execution level

See also

Packages List