Struct CapeRegistryKey

pub struct CapeRegistryKey {
    pub(crate) interface: *mut ICapeRegistryKey,
}

A class that provides access to a COBIA registry key in a read-only manner

This class provides access to a COBIA registry key in a read-only manner; for writing to the COBIA registry, consider using CapeRegistryKeyWriter.

Example

use cobia;
use cobia::prelude::*;
cobia::cape_open_initialize().unwrap();
let lib_key=cobia::CapeRegistryKey::from_path("/types/libraries/{8d1d724f-ab15-48e5-80e4-a612468e68d4}").unwrap(); //points to the CAPE-OPEN 1.2 type library
assert_eq!(lib_key.get_string_value("name",None).unwrap(), "CAPEOPEN_1_2".to_string()); //check its name
cobia::cape_open_cleanup();

Fields

interface: *mut ICapeRegistryKey

Implementations

impl CapeRegistryKey

pub fn new() -> Result<CapeRegistryKey, COBIAError>

Get a reference to the root key

This method returns a reference to the root key.

Example

use cobia;
use cobia::prelude::*;
cobia::cape_open_initialize().unwrap();
let root_key=cobia::CapeRegistryKey::new().unwrap(); //points to the root key
//note the absense of a leading slash in the sub-key to the root key
assert_eq!(root_key.get_string_value("name",Some("types/libraries/{8d1d724f-ab15-48e5-80e4-a612468e68d4}")).unwrap(), "CAPEOPEN_1_2".to_string()); //check name of CAPE-OPEN 1.2 type library
cobia::cape_open_cleanup();

pub fn from_path(loc: &str) -> Result<CapeRegistryKey, COBIAError>

Get a reference to a key from a path

This method returns a reference to a key from a path.

Arguments

• loc - The path to the key to get

Example

use cobia;
use cobia::prelude::*;
cobia::cape_open_initialize().unwrap();
let lib_key=cobia::CapeRegistryKey::from_path("/types/libraries/{8d1d724f-ab15-48e5-80e4-a612468e68d4}").unwrap(); //points to the CAPE-OPEN 1.2 type library
assert_eq!(lib_key.get_string_value("name",None).unwrap(), "CAPEOPEN_1_2".to_string()); //check its name
cobia::cape_open_cleanup();

Trait Implementations

impl CapeRegistryKeyReader for CapeRegistryKey

fn get_values(&self) -> Result<Vec<String>, COBIAError>

Get a list of all values names in the key

fn get_keys(&self) -> Result<Vec<String>, COBIAError>

Get a list of all sub key names in the key

fn get_value_type( &self, value_name: &str, sub_key: Option<&str>, ) -> Result<CapeRegistryValueType, COBIAError>

Get the type of a value

fn get_string_value( &self, value_name: &str, sub_key: Option<&str>, ) -> Result<String, COBIAError>

Get a string value

fn get_integer_value( &self, value_name: &str, sub_key: Option<&str>, ) -> Result<i32, COBIAError>

Get an integer value

fn get_uuid_value( &self, value_name: &str, sub_key: Option<&str>, ) -> Result<CapeUUID, COBIAError>

Get a UUID value

fn get_sub_key(&self, key_name: &str) -> Result<CapeRegistryKey, COBIAError>

Get a sub key

fn is_all_users(&self, value_name: &str) -> Result<bool, COBIAError>

Check whether a particular value is in the registry for all users or just the current user

impl CapeRegistryKeyReaderKey for CapeRegistryKey

fn get_read_key(&self) -> *mut ICapeRegistryKey

impl Clone for CapeRegistryKey

Add pointer reference

ICapeRegistryKey derives from ICobiaBase, which contains addReference() and release(). The Clone trait calls addReference.

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Drop for CapeRegistryKey

Release pointer

ICapeRegistryKey derives from ICobiaBase, which contains addReference() and release(). The Drop trait calls release.

fn drop(&mut self)

Executes the destructor for this type.