Struct winsafe::HKEY

#[repr(C)]
pub struct HKEY { /* fields omitted */ }

Handle to a registry key.

This handle also exposes several predefined registry keys, like HKEY::CURRENT_USER, which are always open and ready to be used. Usually, they are the starting point to open a registry key.

Implementations

impl HKEY

pub const NULL: Self

The null, invalid handle.

This constant is common to all handle types.

pub unsafe fn from_ptr<T>(p: *mut T) -> HKEY

Creates a new handle instance by wrapping a pointer.

This method is common to all handle types.

pub unsafe fn as_ptr(self) -> *mut c_void

Consumes the handle returning the underlying raw pointer.

This method is common to all handle types.

pub fn is_null(self) -> bool

Tells if the handle is invalid (null).

This method is common to all handle types.

pub fn as_opt(self) -> Option<HKEY>

Consumes the handle into an option, which is None if the handle pointer is null.

This method is common to all handle types.

impl HKEY

pub const CLASSES_ROOT: Self

Predefined registry key, always open.

pub const CURRENT_USER: Self

Predefined registry key, always open.

pub const LOCAL_MACHINE: Self

Predefined registry key, always open.

pub const USERS: Self

Predefined registry key, always open.

pub const PERFORMANCE_DATA: Self

Predefined registry key, always open.

pub const PERFORMANCE_TEXT: Self

Predefined registry key, always open.

pub const PERFORMANCE_NLSTEXT: Self

Predefined registry key, always open.

pub const CURRENT_CONFIG: Self

Predefined registry key, always open.

pub const DYN_DATA: Self

Predefined registry key, always open.

pub const CURRENT_USER_LOCAL_SETTINGS: Self

Predefined registry key, always open.

pub fn CloseKey(self) -> WinResult<()>

RegCloseKey method.

pub fn EnumKeyEx(self) -> WinResult<Vec<String>>

This method calls RegEnumKeyEx method repeatedly to retrieve all key names.

Examples

use winsafe::{co, HKEY};

let hkey = HKEY::CURRENT_USER.OpenKeyEx(
    "Control Panel",
    co::REG_OPTION::default(),
    co::KEY::READ,
)?;

let key_names = hkey.EnumKeyEx()?;
for key_name in key_names.iter() {
    println!("{}", key_name);
}

hkey.CloseKey()?;

pub fn EnumValue(self) -> WinResult<Vec<(String, REG)>>

This method calls RegEnumValue method repeatedly to retrieve all value names and types.

Examples

use winsafe::{co, HKEY};

let hkey = HKEY::CURRENT_USER.OpenKeyEx(
    "Control Panel\\Appearance",
    co::REG_OPTION::default(),
    co::KEY::READ,
)?;

let values_and_types = hkey.EnumValue()?;
for (value, reg_type) in values_and_types.iter() {
    println!("{}, {}", value, reg_type);
}

hkey.CloseKey()?;

pub fn GetValue(self, sub_key: &str, value: &str) -> WinResult<RegistryValue>

RegGetValue method.

The data type will be automatically queried with a first call to RegGetValue.

Examples

use winsafe::{HKEY, RegistryValue};

let val = HKEY::CURRENT_USER.GetValue(
    "Control Panel\\Mouse",
    "Beep",
)?;

match val {
    RegistryValue::Dword(n) => println!("Number u32: {}", n),
    RegistryValue::Qword(n) => println!("Number u64: {}", n),
    RegistryValue::Sz(str) => println!("String: {}", str),
    RegistryValue::Binary(bin) => {
        println!("Binary:");
        for b in bin.iter() {
            print!("{:02x} ", b);
        }
        println!("");
    },
    RegistryValue::None => println!("No value"),
}

pub fn OpenKeyEx(
    self,
    sub_key: &str,
    options: REG_OPTION,
    access_rights: KEY
) -> WinResult<HKEY>

RegOpenKeyEx method.

Note: Must be paired with an HKEY::CloseKey call.

Examples

use winsafe::{co, HKEY};

let hkey = HKEY::CURRENT_USER.OpenKeyEx(
    "Control Panel\\Mouse",
    co::REG_OPTION::default(),
    co::KEY::READ,
)?;

hkey.CloseKey()?;

pub fn QueryInfoKey(
    self,
    class: Option<&mut WString>,
    num_sub_keys: Option<&mut u32>,
    max_sub_key_name_len: Option<&mut u32>,
    max_class_len: Option<&mut u32>,
    num_values: Option<&mut u32>,
    max_value_name_len: Option<&mut u32>,
    max_value_len: Option<&mut u32>,
    security_descr_len: Option<&mut u32>,
    last_write_time: Option<&mut FILETIME>
) -> WinResult<()>

RegQueryInfoKey method.

pub fn QueryValueEx(self, value: &str) -> WinResult<RegistryValue>

RegQueryValueEx method.

The data type will be automatically queried with a first call to RegQueryValueEx.

Examples

use winsafe::{co, HKEY, RegistryValue};

let hkey = HKEY::CURRENT_USER.OpenKeyEx(
    "Control Panel\\Mouse",
    co::REG_OPTION::default(),
    co::KEY::READ,
)?;

let val = hkey.QueryValueEx("Beep")?;

match val {
    RegistryValue::Dword(n) => println!("Number u32: {}", n),
    RegistryValue::Qword(n) => println!("Number u64: {}", n),
    RegistryValue::Sz(str) => println!("String: {}", str),
    RegistryValue::Binary(bin) => {
        println!("Binary:");
        for b in bin.iter() {
            print!("{:02x} ", b);
        }
        println!("");
    },
    RegistryValue::None => println!("No value"),
}

hkey.CloseKey()?;

pub fn SetKeyValue(
    self,
    sub_key: &str,
    value: &str,
    data: RegistryValue
) -> WinResult<()>

RegSetKeyValue method.

If the value doesn’t exist, if will be created. If new type is different from current type, new type will take over.

Examples

use winsafe::{HKEY, RegistryValue};

HKEY::CURRENT_USER.SetKeyValue(
    "Software\\My Company",
    "Color",
    RegistryValue::Sz("blue".to_owned()),
)?;

pub fn SetValueEx(self, value: &str, data: RegistryValue) -> WinResult<()>

RegSetValueEx method.

If the value doesn’t exist, if will be created. If new type is different from current type, new type will prevail.

Examples

use winsafe::{co, HKEY, RegistryValue};

let hkey = HKEY::CURRENT_USER.OpenKeyEx(
    "Console\\Git Bash",
    co::REG_OPTION::default(),
    co::KEY::ALL_ACCESS,
)?;

hkey.SetValueEx(
    "Color",
    RegistryValue::Sz("blue".to_owned()),
)?;

hkey.CloseKey()?;

Trait Implementations

impl Binary for HKEY

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Clone for HKEY

fn clone(&self) -> HKEY

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for HKEY

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for HKEY

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl LowerHex for HKEY

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Octal for HKEY

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<HKEY> for HKEY

fn eq(&self, other: &HKEY) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &HKEY) -> bool

This method tests for !=.

impl UpperHex for HKEY

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Copy for HKEY

impl Eq for HKEY

impl Send for HKEY

impl StructuralEq for HKEY

impl StructuralPartialEq for HKEY

impl Sync for HKEY