WinStd
Additional templates and function helpers for Microsoft Windows using Standard C++ classes
Public Member Functions | Protected Member Functions | List of all members
winstd::crypt_hash Class Reference

HCRYPTHASH wrapper class. More...

#include <WinStd/Crypt.h>

Inheritance diagram for winstd::crypt_hash:
winstd::dplhandle< HCRYPTHASH, NULL > winstd::handle< HCRYPTHASH, INVAL >

Public Member Functions

virtual ~crypt_hash ()
 Destroys the hash context. More...
 
bool create (1 HCRYPTPROV hProv, 1 ALG_ID Algid, 1 HCRYPTKEY hKey=NULL, 1 DWORD dwFlags=0) noexcept
 Creates the hash context. More...
 
- Public Member Functions inherited from winstd::dplhandle< HCRYPTHASH, NULL >
 dplhandle () noexcept
 Initializes a new class instance with the object handle set to INVAL.
 
 dplhandle (1 handle_type h) noexcept
 Initializes a new class instance with an already available object handle. More...
 
 dplhandle (1 const dplhandle< handle_type, INVAL > &h) noexcept
 Copy constructor. More...
 
 dplhandle (1 dplhandle< handle_type, INVAL > &&h) noexcept
 Move constructor. More...
 
dplhandle< handle_type, INVAL > & operator= (1 handle_type h) noexcept
 Attaches already available object handle. More...
 
dplhandle< handle_type, INVAL > & operator= (1 const dplhandle< handle_type, INVAL > &h) noexcept
 Duplicates the object. More...
 
dplhandle< handle_type, INVAL > & operator= (1 dplhandle< handle_type, INVAL > &&h) noexcept
 Moves the object. More...
 
handle_type duplicate () const
 Duplicates and returns a new object handle. More...
 
bool attach_duplicated (1 handle_type h)
 Duplicates an object handle and sets a new object handle. More...
 
- Public Member Functions inherited from winstd::handle< HCRYPTHASH, INVAL >
 handle () noexcept
 Initializes a new class instance with the object handle set to INVAL.
 
 handle (1 handle_type h) noexcept
 Initializes a new class instance with an already available object handle. More...
 
 handle (1 handle< handle_type, INVAL > &&h) noexcept
 Move constructor. More...
 
handle< handle_type, INVAL > & operator= (1 handle_type h) noexcept
 Attaches already available object handle. More...
 
handle< handle_type, INVAL > & operator= (1 handle< handle_type, INVAL > &&h) noexcept
 Move assignment. More...
 
 operator handle_type () const
 Auto-typecasting operator. More...
 
handle_type *& operator* () const
 Returns the object handle value when the object handle is a pointer to a value (class, struct, etc.). More...
 
handle_typeoperator& ()
 Returns the object handle reference. More...
 
handle_type operator-> () const
 Provides object handle member access when the object handle is a pointer to a class or struct. More...
 
bool operator! () const
 Tests if the object handle is INVAL. More...
 
bool operator< (1 handle_type h) const
 Is handle less than? More...
 
bool operator<= (1 handle_type h) const
 Is handle less than or equal to? More...
 
bool operator>= (1 handle_type h) const
 Is handle greater than or equal to? More...
 
bool operator> (1 handle_type h) const
 Is handle greater than? More...
 
bool operator!= (1 handle_type h) const
 Is handle not equal to? More...
 
bool operator== (1 handle_type h) const
 Is handle equal to? More...
 
void attach (1 handle_type h) noexcept
 Sets a new object handle for the class. More...
 
handle_type detach ()
 Dismisses the object handle from this class. More...
 
void free ()
 Destroys the object.
 

Protected Member Functions

void free_internal () noexcept override
 Destroys the hash context. More...
 
handle_type duplicate_internal (1 handle_type h) const noexcept override
 Duplicates the hash context. More...
 
virtual handle_type duplicate_internal (1 handle_type h) const noexcept=0
 Abstract member function that must be implemented by child classes to do the actual object handle duplication. More...
 
virtual void free_internal () noexcept=0
 Abstract member function that must be implemented by child classes to do the actual object destruction. More...
 

Additional Inherited Members

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

Detailed Description

HCRYPTHASH wrapper class.

Constructor & Destructor Documentation

◆ ~crypt_hash()

virtual winstd::crypt_hash::~crypt_hash ( )
inlinevirtual

Destroys the hash context.

See also
CryptDestroyHash function

Member Function Documentation

◆ create()

bool winstd::crypt_hash::create ( 1 HCRYPTPROV  hProv,
1 ALG_ID  Algid,
1 HCRYPTKEY  hKey = NULL,
1 DWORD  dwFlags = 0 
)
inlinenoexcept

Creates the hash context.

Returns
  • true when creation succeeds;
  • false when creation fails. For extended error information, call GetLastError().
See also
CryptCreateHash function

◆ duplicate_internal()

handle_type winstd::crypt_hash::duplicate_internal ( 1 handle_type  h) const
inlineoverrideprotectedvirtualnoexcept

Duplicates the hash context.

Parameters
[in]hObject handle of existing hash context
Returns
Duplicated hash context handle
See also
CryptDuplicateHash function

Implements winstd::dplhandle< HCRYPTHASH, NULL >.

◆ free_internal()

void winstd::crypt_hash::free_internal ( )
inlineoverrideprotectedvirtualnoexcept

Destroys the hash context.

See also
CryptDestroyHash function

Implements winstd::handle< HCRYPTHASH, INVAL >.


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