HandleGuard< T > Class Template Reference

#include <PKIFCNGUtils.h>

Inheritance diagram for HandleGuard< T >:

[legend]

Collaboration diagram for HandleGuard< T >:

[legend]

List of all members.

---

Detailed Description

template<typename T>
class HandleGuard< T >

a base class for scoped opaque CAPI handles

TSP-enforcing: No

Definition at line 175 of file PKIFCNGUtils.h.

Public Member Functions
	HandleGuard (T ptr=0)
virtual	~HandleGuard ()
virtual void	clear ()=0
T	get () const
T	operator-> () const
	operator const T () const
	operator T ()
T *	operator & () const
T	assign (T ptr)
void	reset (T ptr)
T	release ()
Protected Attributes
T	m_ptr

---

Constructor & Destructor Documentation

template<typename T>

HandleGuard< T >::HandleGuard

(

T

ptr = 0

)

[inline, explicit]

Interface: Subsystem

Explicit constructor

Returns:

None

Definition at line 185 of file PKIFCNGUtils.h.

template<typename T>

virtual HandleGuard< T >::~HandleGuard

(

)

[inline, virtual]

Interface: Subsystem

Destructor

Returns:

None

Definition at line 196 of file PKIFCNGUtils.h.

---

Member Function Documentation

template<typename T>

virtual void HandleGuard< T >::clear

(

)

[pure virtual]

Implemented in CNGPtr< T, R, >, CNGFlagsPtr< T, R, F, >, and CNGPtrCF< T >.

Referenced by HandleGuard< T >::reset().

template<typename T>

T HandleGuard< T >::get

(

)

const [inline]

Definition at line 202 of file PKIFCNGUtils.h.

References HandleGuard< T >::m_ptr.

template<typename T>

T HandleGuard< T >::operator->

(

)

const [inline]

Definition at line 207 of file PKIFCNGUtils.h.

References HandleGuard< T >::m_ptr.

template<typename T>

HandleGuard< T >::operator const T

(

)

const [inline]

Interface: Subsystem

Allow the smart pointers to be passed as arguments where const T & is required

Returns:

None

Definition at line 219 of file PKIFCNGUtils.h.

References HandleGuard< T >::m_ptr.

template<typename T>

HandleGuard< T >::operator T

(

)

[inline]

Definition at line 224 of file PKIFCNGUtils.h.

References HandleGuard< T >::m_ptr.

template<typename T>

T* HandleGuard< T >::operator &

(

)

const [inline]

Definition at line 229 of file PKIFCNGUtils.h.

References HandleGuard< T >::m_ptr.

template<typename T>

T HandleGuard< T >::assign

(

T

ptr

)

[inline]

Interface: Subsystem

Replace the underlying pointer without cleaning it up. the old pointer is returned and the caller is responsible for cleaning

Returns:

None

Definition at line 242 of file PKIFCNGUtils.h.

References HandleGuard< T >::m_ptr.

Referenced by HandleGuard< T >::reset().

template<typename T>

void HandleGuard< T >::reset

(

T

ptr

)

[inline]

Interface: Subsystem

Clean and replace the underlying pointer

Returns:

None

Definition at line 256 of file PKIFCNGUtils.h.

References HandleGuard< T >::assign(), and HandleGuard< T >::clear().

template<typename T>

T HandleGuard< T >::release

(

)

[inline]

Interface: Subsystem

Break the association with the underlying pointer. the caller is responsible for freeing it after this

Returns:

None

Definition at line 270 of file PKIFCNGUtils.h.

References HandleGuard< T >::m_ptr.

---

Member Data Documentation

template<typename T>

T HandleGuard< T >::m_ptr [protected]

Definition at line 278 of file PKIFCNGUtils.h.

Referenced by HandleGuard< T >::assign(), CNGPtrCF< T >::clear(), CNGFlagsPtr< T, R, F, >::clear(), CNGPtr< T, R, >::clear(), CNGFlagsPtr< T, R, F, >::CNGFlagsPtr(), CNGPtr< T, R, >::CNGPtr(), CNGPtrCF< T >::CNGPtrCF(), HandleGuard< T >::get(), HandleGuard< T >::operator &(), HandleGuard< T >::operator const T(), HandleGuard< T >::operator T(), HandleGuard< T >::operator->(), and HandleGuard< T >::release().

---

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

• PKIFCNGUtils.h