RegistryApi 1.0.1

dotnet add package RegistryApi --version 1.0.1
                    
NuGet\Install-Package RegistryApi -Version 1.0.1
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="RegistryApi" Version="1.0.1" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="RegistryApi" Version="1.0.1" />
                    
Directory.Packages.props
<PackageReference Include="RegistryApi" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add RegistryApi --version 1.0.1
                    
#r "nuget: RegistryApi, 1.0.1"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package RegistryApi@1.0.1
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=RegistryApi&version=1.0.1
                    
Install as a Cake Addin
#tool nuget:?package=RegistryApi&version=1.0.1
                    
Install as a Cake Tool

RegistryApi

Eine umfassende Windows Registry Management Library für .NET, die sichere und effiziente Operationen zum Lesen, Schreiben und Verwalten von Registry-Schlüsseln und -Werten bereitstellt.

Features

Kernfunktionalitäten

  • Registry-Werte lesen und schreiben - Unterstützt alle Registry-Datentypen (String, DWord, QWord, Binary, MultiString, ExpandString)
  • Registry-Schlüssel erstellen und löschen - Mit rekursiven Optionen
  • Registry-Schlüssel und -Werte suchen - Mit Wildcard-Unterstützung
  • Registry-Backup und -Wiederherstellung - JSON- und Registry-basierte Backups
  • Umfassende Fehlerbehandlung - Spezifische Exceptions für verschiedene Fehlertypen

Unterstützte Registry-Hives

  • HKEY_CLASSES_ROOT (HKCR)
  • HKEY_CURRENT_USER (HKCU)
  • HKEY_LOCAL_MACHINE (HKLM)
  • HKEY_USERS (HKU)
  • HKEY_CURRENT_CONFIG (HKCC)

Installation

dotnet add package RegistryApi

Verwendung

Basis-Setup

using RegistryApi;

var registryManager = new RegistryManager();

Registry-Werte lesen

// Sicheres Lesen mit Standardwerten
string appName = registryManager.ReadValue<string>(
    "HKCU\\Software\\MyApp", 
    "ApplicationName", 
    "DefaultApp"
);

// Striktes Lesen (wirft Exception bei Fehlern)
try
{
    int timeout = registryManager.ReadValueStrict<int>(
        "HKLM\\Software\\MyApp", 
        "Timeout"
    );
}
catch (RegistryKeyNotFoundException ex)
{
    Console.WriteLine($"Schlüssel nicht gefunden: {ex.KeyPath}");
}

Registry-Werte schreiben

// Sicheres Schreiben (gibt bool zurück)
bool success = registryManager.WriteValue(
    "HKCU\\Software\\MyApp", 
    "Version", 
    "1.0.0", 
    RegistryValueType.String
);

// Striktes Schreiben (wirft Exception bei Fehlern)
registryManager.WriteValueStrict(
    "HKCU\\Software\\MyApp", 
    "InstallCount", 
    1, 
    RegistryValueType.DWord
);

Registry-Schlüssel verwalten

// Schlüssel erstellen
registryManager.CreateKey("HKCU\\Software\\MyApp\\Settings");

// Schlüssel prüfen
if (registryManager.KeyExists("HKCU\\Software\\MyApp"))
{
    Console.WriteLine("Schlüssel existiert");
}

// Schlüssel löschen (rekursiv)
registryManager.DeleteKey("HKCU\\Software\\MyApp", recursive: true);

Registry durchsuchen

// Unterschlüssel auflisten
var subKeys = registryManager.EnumerateSubKeys("HKLM\\Software", recursive: false);

// Nach Werten suchen (mit Wildcards)
var results = registryManager.SearchValues(
    "HKCU\\Software", 
    "Install*", 
    recursive: true
);

// Nach Schlüsseln suchen
var keys = registryManager.SearchKeys(
    "HKLM\\Software", 
    "*Microsoft*", 
    recursive: true
);

Backup und Wiederherstellung

// JSON-Backup erstellen
registryManager.BackupKeyToJson(
    "HKCU\\Software\\MyApp", 
    @"C:\backup\myapp-backup.json"
);

// Aus JSON wiederherstellen
registryManager.RestoreKeyFromJson(
    @"C:\backup\myapp-backup.json", 
    overwrite: true
);

// Registry-zu-Registry Backup
registryManager.BackupKeyToRegistry(
    "HKCU\\Software\\MyApp", 
    "HKCU\\Software\\MyApp_Backup"
);

// Aus Registry-Backup wiederherstellen
registryManager.RestoreKeyFromRegistry(
    "HKCU\\Software\\MyApp_Backup", 
    "HKCU\\Software\\MyApp", 
    overwrite: true
);

Erweiterte Operationen

// Detaillierte Schlüssel-Informationen abrufen
var keyInfo = registryManager.GetKeyInfo("HKLM\\Software\\Microsoft");
if (keyInfo != null)
{
    Console.WriteLine($"Schlüssel: {keyInfo.Path}");
    Console.WriteLine($"Unterschlüssel: {keyInfo.SubKeys.Count}");
    Console.WriteLine($"Werte: {keyInfo.Values.Count}");
}

// Alle Werte eines Schlüssels abrufen
var allValues = registryManager.GetAllValues(
    "HKCU\\Software\\MyApp", 
    includeSubKeys: true
);

foreach (var kvp in allValues)
{
    Console.WriteLine($"{kvp.Key} = {kvp.Value}");
}

Fehlerbehandlung

Die Library bietet spezifische Exception-Typen für verschiedene Fehlersituationen:

try
{
    var value = registryManager.ReadValueStrict<string>("HKLM\\Invalid\\Path", "Value");
}
catch (RegistryKeyNotFoundException ex)
{
    Console.WriteLine($"Schlüssel nicht gefunden: {ex.KeyPath}");
}
catch (RegistryAccessDeniedException ex)
{
    Console.WriteLine($"Zugriff verweigert: {ex.KeyPath}");
}
catch (RegistryValueNotFoundException ex)
{
    Console.WriteLine($"Wert '{ex.ValueName}' nicht gefunden in: {ex.KeyPath}");
}
catch (InvalidRegistryPathException ex)
{
    Console.WriteLine($"Ungültiger Registry-Pfad: {ex.KeyPath}");
}

Registry-Datentypen

Die Library unterstützt alle Standard-Registry-Datentypen:

// String-Wert
registryManager.WriteValue("HKCU\\Test", "StringValue", "Hello", RegistryValueType.String);

// DWORD (32-bit Integer)
registryManager.WriteValue("HKCU\\Test", "DWordValue", 42, RegistryValueType.DWord);

// QWORD (64-bit Integer)  
registryManager.WriteValue("HKCU\\Test", "QWordValue", 123456789L, RegistryValueType.QWord);

// Binary-Daten
var binaryData = new byte[] { 0x01, 0x02, 0x03, 0x04 };
registryManager.WriteValue("HKCU\\Test", "BinaryValue", binaryData, RegistryValueType.Binary);

// Multi-String (String-Array)
var strings = new[] { "String1", "String2", "String3" };
registryManager.WriteValue("HKCU\\Test", "MultiString", strings, RegistryValueType.MultiString);

// Expandable String (mit Umgebungsvariablen)
registryManager.WriteValue("HKCU\\Test", "ExpandString", "%USERPROFILE%\\Documents", RegistryValueType.ExpandString);

Systemanforderungen

  • .NET 6.0 oder höher
  • Windows-Betriebssystem
  • Angemessene Registry-Berechtigungen für die gewünschten Operationen

Lizenz

MIT License

Beiträge

Beiträge sind willkommen! Bitte erstellen Sie einen Issue oder Pull Request auf GitHub.

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • net8.0

    • No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.0.1 127 9/9/2025
1.0.0 121 9/8/2025