WinStd
Windows Win32 API using Standard C++
Loading...
Searching...
No Matches
winstd::reg_key Class Reference

Registry key wrapper class. More...

#include <WinStd/Win.h>

Inheritance diagram for winstd::reg_key:
winstd::handle< HKEY, NULL >

Public Member Functions

virtual ~reg_key ()
 Closes a handle to the registry key.
 
bool delete_subkey (LPCTSTR szSubkey)
 Deletes the specified registry subkey.
 
- Public Member Functions inherited from winstd::handle< HKEY, NULL >
 handle () noexcept
 Initializes a new class instance with the object handle set to INVAL.
 
 handle (handle_type h) noexcept
 Initializes a new class instance with an already available object handle.
 
 handle (handle< handle_type, INVAL > &&h) noexcept
 Move constructor.
 
handle< handle_type, INVAL > & operator= (handle_type h) noexcept
 Attaches already available object handle.
 
handle< handle_type, INVAL > & operator= (handle< handle_type, INVAL > &&h) noexcept
 Move assignment.
 
 operator handle_type () const
 Auto-typecasting operator.
 
handle_type *& operator* () const
 Returns the object handle value when the object handle is a pointer to a value (class, struct, etc.).
 
handle_typeoperator& ()
 Returns the object handle reference.
 
handle_type operator-> () const
 Provides object handle member access when the object handle is a pointer to a class or struct.
 
bool operator! () const
 Tests if the object handle is invalid.
 
bool operator< (handle_type h) const
 Is handle less than?
 
bool operator<= (handle_type h) const
 Is handle less than or equal to?
 
bool operator>= (handle_type h) const
 Is handle greater than or equal to?
 
bool operator> (handle_type h) const
 Is handle greater than?
 
bool operator!= (handle_type h) const
 Is handle not equal to?
 
bool operator== (handle_type h) const
 Is handle equal to?
 
void attach (handle_type h) noexcept
 Sets a new object handle for the class.
 
handle_type detach ()
 Dismisses the object handle from this class.
 
void free ()
 Destroys the object.
 

Protected Member Functions

void free_internal () noexcept override
 Closes a handle to the registry key.
 
- Protected Member Functions inherited from winstd::handle< HKEY, NULL >

Additional Inherited Members

- Public Types inherited from winstd::handle< HKEY, NULL >
typedef HKEY handle_type
 Datatype of the object handle this template class handles.
 
- Static Public Attributes inherited from winstd::handle< HKEY, NULL >
static const HKEY invalid
 Invalid handle value.
 
- Protected Attributes inherited from winstd::handle< HKEY, NULL >
handle_type m_h
 Object handle.
 

Detailed Description

Registry key wrapper class.

See also
RegCreateKeyEx function
RegOpenKeyEx function

Constructor & Destructor Documentation

◆ ~reg_key()

virtual winstd::reg_key::~reg_key ( )
inlinevirtual

Closes a handle to the registry key.

See also
RegCloseKey function

Member Function Documentation

◆ delete_subkey()

bool winstd::reg_key::delete_subkey ( LPCTSTR szSubkey)
inline

Deletes the specified registry subkey.

Parameters
[in]szSubkeyName of the subkey to delete
Returns
  • true when creation succeeds;
  • false when creation fails. For extended error information, call GetLastError().

◆ free_internal()

void winstd::reg_key::free_internal ( )
inlineoverrideprotectedvirtualnoexcept

Closes a handle to the registry key.

See also
RegCloseKey function

Implements winstd::handle< HKEY, NULL >.


The documentation for this class was generated from the following file: