Skip to content

Latest commit

 

History

History
367 lines (275 loc) · 10.6 KB

functions.rst

File metadata and controls

367 lines (275 loc) · 10.6 KB

Functions

Helper functions

wslwinreg.common.winerror_to_errno

wslwinreg::common::winerror_to_errno

wslwinreg.common.convert_to_utf16

wslwinreg::common::convert_to_utf16

wslwinreg.common.to_registry_bytes

wslwinreg::common::to_registry_bytes

wslwinreg.common.from_registry_bytes

wslwinreg::common::from_registry_bytes

wslwinreg.get_HKCU

wslwinreg::get_HKCU

wslwinreg.get_HKLM_32

wslwinreg::get_HKLM_32

wslwinreg.get_HKLM_64

wslwinreg::get_HKLM_64

Null implementation

On operating systems such as macOS and Linux that doesn't have a Windows operating system underpinning, all functions will raise a NotImplementedError exception.

wslwinreg.nullapi.CloseKey

wslwinreg::nullapi::CloseKey

wslwinreg.nullapi.ConnectRegistry

wslwinreg::nullapi::ConnectRegistry

wslwinreg.nullapi.CreateKey

wslwinreg::nullapi::CreateKey

wslwinreg.nullapi.CreateKeyEx

wslwinreg::nullapi::CreateKeyEx

wslwinreg.nullapi.DeleteKey

wslwinreg::nullapi::DeleteKey

wslwinreg.nullapi.DeleteKeyEx

wslwinreg::nullapi::DeleteKeyEx

wslwinreg.nullapi.DeleteValue

wslwinreg::nullapi::DeleteValue

wslwinreg.nullapi.EnumKey

wslwinreg::nullapi::EnumKey

wslwinreg.nullapi.EnumValue

wslwinreg::nullapi::EnumValue

wslwinreg.nullapi.ExpandEnvironmentStrings

wslwinreg::nullapi::ExpandEnvironmentStrings

wslwinreg.nullapi.FlushKey

wslwinreg::nullapi::FlushKey

wslwinreg.nullapi.LoadKey

wslwinreg::nullapi::LoadKey

wslwinreg.nullapi.OpenKey

wslwinreg::nullapi::OpenKey

wslwinreg.nullapi.OpenKeyEx

wslwinreg::nullapi::OpenKeyEx

wslwinreg.nullapi.QueryInfoKey

wslwinreg::nullapi::QueryInfoKey

wslwinreg.nullapi.QueryValue

wslwinreg::nullapi::QueryValue

wslwinreg.nullapi.QueryValueEx

wslwinreg::nullapi::QueryValueEx

wslwinreg.nullapi.SaveKey

wslwinreg::nullapi::SaveKey

wslwinreg.nullapi.SetValue

wslwinreg::nullapi::SetValue

wslwinreg.nullapi.SetValueEx

wslwinreg::nullapi::SetValueEx

wslwinreg.nullapi.DisableReflectionKey

wslwinreg::nullapi::DisableReflectionKey

wslwinreg.nullapi.EnableReflectionKey

wslwinreg::nullapi::EnableReflectionKey

wslwinreg.nullapi.QueryReflectionKey

wslwinreg::nullapi::QueryReflectionKey

wslwinreg.nullapi.convert_to_windows_path

wslwinreg::nullapi::convert_to_windows_path

wslwinreg.nullapi.convert_from_windows_path

wslwinreg::nullapi::convert_from_windows_path

wslwinreg.nullapi.get_file_info

wslwinreg::nullapi::get_file_info

Cygwin / MSYS2 implementation

On Cygwin and MSYS2 platforms, the CDLL exposes the Windows API directly so these python functions mimic the C code from Python for Windows and calls the Windows API to perform the low level work.

wslwinreg.cygwinapi.CloseKey

wslwinreg::cygwinapi::CloseKey

wslwinreg.cygwinapi.ConnectRegistry

wslwinreg::cygwinapi::ConnectRegistry

wslwinreg.cygwinapi.CreateKey

wslwinreg::cygwinapi::CreateKey

wslwinreg.cygwinapi.CreateKeyEx

wslwinreg::cygwinapi::CreateKeyEx

wslwinreg.cygwinapi.DeleteKey

wslwinreg::cygwinapi::DeleteKey

wslwinreg.cygwinapi.DeleteKeyEx

wslwinreg::cygwinapi::DeleteKeyEx

wslwinreg.cygwinapi.DeleteValue

wslwinreg::cygwinapi::DeleteValue

wslwinreg.cygwinapi.EnumKey

wslwinreg::cygwinapi::EnumKey

wslwinreg.cygwinapi.EnumValue

wslwinreg::cygwinapi::EnumValue

wslwinreg.cygwinapi.ExpandEnvironmentStrings

wslwinreg::cygwinapi::ExpandEnvironmentStrings

wslwinreg.cygwinapi.FlushKey

wslwinreg::cygwinapi::FlushKey

wslwinreg.cygwinapi.LoadKey

wslwinreg::cygwinapi::LoadKey

wslwinreg.cygwinapi.OpenKey

wslwinreg::cygwinapi::OpenKey

wslwinreg.cygwinapi.OpenKeyEx

wslwinreg::cygwinapi::OpenKeyEx

wslwinreg.cygwinapi.QueryInfoKey

wslwinreg::cygwinapi::QueryInfoKey

wslwinreg.cygwinapi.QueryValue

wslwinreg::cygwinapi::QueryValue

wslwinreg.cygwinapi.QueryValueEx

wslwinreg::cygwinapi::QueryValueEx

wslwinreg.cygwinapi.SaveKey

wslwinreg::cygwinapi::SaveKey

wslwinreg.cygwinapi.SetValue

wslwinreg::cygwinapi::SetValue

wslwinreg.cygwinapi.SetValueEx

wslwinreg::cygwinapi::SetValueEx

wslwinreg.cygwinapi.DisableReflectionKey

wslwinreg::cygwinapi::DisableReflectionKey

wslwinreg.cygwinapi.EnableReflectionKey

wslwinreg::cygwinapi::EnableReflectionKey

wslwinreg.cygwinapi.QueryReflectionKey

wslwinreg::cygwinapi::QueryReflectionKey

wslwinreg.cygwinapi.convert_to_windows_path

wslwinreg::cygwinapi::convert_to_windows_path

wslwinreg.cygwinapi.convert_from_windows_path

wslwinreg::cygwinapi::convert_from_windows_path

wslwinreg.cygwinapi.get_file_info

wslwinreg::cygwinapi::get_file_info

Windows Subsystem for Linux implementation

On Windows Subsystem for Windows, the calls are sent to a server that will issue the calls directly in the Windows host which performs the actual the low level work.

wslwinreg.wslapi.CloseKey

wslwinreg::wslapi::CloseKey

wslwinreg.wslapi.ConnectRegistry

wslwinreg::wslapi::ConnectRegistry

wslwinreg.wslapi.CreateKey

wslwinreg::wslapi::CreateKey

wslwinreg.wslapi.CreateKeyEx

wslwinreg::wslapi::CreateKeyEx

wslwinreg.wslapi.DeleteKey

wslwinreg::wslapi::DeleteKey

wslwinreg.wslapi.DeleteKeyEx

wslwinreg::wslapi::DeleteKeyEx

wslwinreg.wslapi.DeleteValue

wslwinreg::wslapi::DeleteValue

wslwinreg.wslapi.EnumKey

wslwinreg::wslapi::EnumKey

wslwinreg.wslapi.EnumValue

wslwinreg::wslapi::EnumValue

wslwinreg.wslapi.ExpandEnvironmentStrings

wslwinreg::wslapi::ExpandEnvironmentStrings

wslwinreg.wslapi.FlushKey

wslwinreg::wslapi::FlushKey

wslwinreg.wslapi.LoadKey

wslwinreg::wslapi::LoadKey

wslwinreg.wslapi.OpenKey

wslwinreg::wslapi::OpenKey

wslwinreg.wslapi.OpenKeyEx

wslwinreg::wslapi::OpenKeyEx

wslwinreg.wslapi.QueryInfoKey

wslwinreg::wslapi::QueryInfoKey

wslwinreg.wslapi.QueryValue

wslwinreg::wslapi::QueryValue

wslwinreg.wslapi.QueryValueEx

wslwinreg::wslapi::QueryValueEx

wslwinreg.wslapi.SaveKey

wslwinreg::wslapi::SaveKey

wslwinreg.wslapi.SetValue

wslwinreg::wslapi::SetValue

wslwinreg.wslapi.SetValueEx

wslwinreg::wslapi::SetValueEx

wslwinreg.wslapi.DisableReflectionKey

wslwinreg::wslapi::DisableReflectionKey

wslwinreg.wslapi.EnableReflectionKey

wslwinreg::wslapi::EnableReflectionKey

wslwinreg.wslapi.QueryReflectionKey

wslwinreg::wslapi::QueryReflectionKey

wslwinreg.wslapi.convert_to_windows_path

wslwinreg::wslapi::convert_to_windows_path

wslwinreg.wslapi.convert_from_windows_path

wslwinreg::wslapi::convert_from_windows_path

wslwinreg.wslapi.get_file_info

wslwinreg::wslapi::get_file_info