winstd::heap Class Reference

Heap handle wrapper. More...

#include <WinStd/Win.h>

Inheritance diagram for winstd::heap:

Public Member Functions
virtual	~heap ()
	Destroys the heap.
bool	enumerate () noexcept
	Enumerates allocated heap blocks using OutputDebugString()
Public Member Functions inherited from winstd::handle< HANDLE, 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_type *	operator& ()
	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
	Destroys the heap.
Protected Member Functions inherited from winstd::handle< HANDLE, NULL >

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

Detailed Description

Heap handle wrapper.

See also

HeapCreate function

Constructor & Destructor Documentation

~heap()

virtual winstd::heap::~heap ( )

inlinevirtual

Destroys the heap.

See also

HeapDestroy function

Member Function Documentation

enumerate()

bool winstd::heap::enumerate ( )

inlinenoexcept

Enumerates allocated heap blocks using OutputDebugString()

Returns

• true if any blocks found;
• false otherwise.

free_internal()

void winstd::heap::free_internal ( )

inlineoverrideprotectedvirtualnoexcept

Destroys the heap.

See also

HeapDestroy function

Implements winstd::handle< HANDLE, NULL >.

---

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

• include/WinStd/Win.h