wslwinreg
Loading...
Searching...
No Matches
wslwinreg Namespace Reference

A drop in replacement for winreg for Cygwin, MSYS2 and Windows Subsystem for Linux. More...

Namespaces

namespace  common
 Windows constants and function common to both WSL and Cygwin implementaions.
namespace  cygwinapi
 Package that implements winreg for MSYS and Cygwin.
namespace  nullapi
 Package that contains stub functions for unsupported platforms.
namespace  wslapi
 Package that implements winreg for Windows Subsystem for Linux.

Classes

class  WinRegKey
 Registry key helper class. More...

Functions

 get_HKCU ()
 Open HKEY_CURRENT_USER.
 get_HKLM_32 ()
 Open HKEY_LOCAL_MACHINE, 32 bit view.
 get_HKLM_64 ()
 Open HKEY_LOCAL_MACHINE, 64 bit view.

Variables

tuple __numversion__ = (1, 1, 2)
 Numeric version.
str __version__ = ".".join([str(num) for num in __numversion__])
 Current version of the library.
str __author__ = "Rebecca Ann Heineman"
 Author's name.
str __title__ = "wslwinreg"
 Name of the module.
str __summary__ = "Drop in replacement for winreg for Cygwin, MSYS2 and WSL"
 Summary of the module's use.
str __uri__ = "http://wslwinreg.readthedocs.io"
 Home page.
str __email__ = "becky@burgerbecky.com"
 Email address for bug reports.
str __license__ = "MIT License"
 Type of license used for distribution.
str __copyright__ = "Copyright 2020-2025 Rebecca Ann Heineman"
 Copyright owner.

Detailed Description

A drop in replacement for winreg for Cygwin, MSYS2 and Windows Subsystem for Linux.

This module provides access to the Windows registry API.

Function Documentation

◆ get_HKCU()

wslwinreg.get_HKCU ( )

Open HKEY_CURRENT_USER.

Returns
Read only WinRegKey for HKEY_CURRENT_USER

◆ get_HKLM_32()

wslwinreg.get_HKLM_32 ( )

Open HKEY_LOCAL_MACHINE, 32 bit view.

Returns
Read only WinRegKey for HKEY_LOCAL_MACHINE with KEY_WOW64_32KEY

◆ get_HKLM_64()

wslwinreg.get_HKLM_64 ( )

Open HKEY_LOCAL_MACHINE, 64 bit view.

Returns
Read only WinRegKey for HKEY_LOCAL_MACHINE with KEY_WOW64_64KEY