atlstl/atlstl.hpp File Reference

---

Detailed Description

[C++ only; requires ATL library] The root header for the ATLSTL project.

#include <stlsoft/stlsoft.h>
#include <atlbase.h>

Go to the source code of this file.

Namespaces
namespace	atlstl
Defines
#define	ATLSTL_INCL_H_ATLSTL
#define	_ATLSTL_VER_MAJOR   1
	The major version number of ATLSTL.
#define	_ATLSTL_VER_MINOR   6
	The minor version number of ATLSTL.
#define	_ATLSTL_VER_REVISION   2
	The revision version number of ATLSTL.
#define	_ATLSTL_VER   _ATLSTL_VER_1_6_2
	The current composite version number of ATLSTL.
#define	ATLSTL_ASSERT(expr)   STLSOFT_ASSERT(expr)
	Defines a runtime assertion.
#define	ATLSTL_MESSAGE_ASSERT(msg, expr)   STLSOFT_MESSAGE_ASSERT(msg, expr)
	Defines a runtime assertion, with message.
#define	ATLSTL_STATIC_ASSERT(expr)   STLSOFT_STATIC_ASSERT(expr)
	Defines a compile-time assertion.
#define	atlstl_ns_qual(x)   ::atlstl::x
	Qualifies with atlstl:: if ATLSTL is using namespaces or, if not, does not qualify.
#define	atlstl_ns_using(x)   using ::atlstl::x;
	Declares a using directive (with respect to atlstl) if ATLSTL is using namespaces or, if not, does nothing.
#define	atlstl_ns_qual_std(x)   ::std::x
	Qualifies with std:: if ATLSTL is being translated in the context of the standard library being within the std namespace or, if not, does not qualify.
#define	atlstl_ns_using_std(x)   using ::std::x;
	Declares a using directive (with respect to std) if ATLSTL is being translated in the context of the standard library being within the std namespace or, if not, does nothing.
#define	atlstl_ns_qual_atl(x)   ::ATL::x
	Qualifies with ATL:: if ATLSTL is being translated in the context of ATL being within the ATL namespace or, if not, does not qualify.
#define	atlstl_ns_using_atl(x)   using ::ATL::x;
	Declares a using directive (with respect to ATL) if ATLSTL is being translated in the context of ATL being within the ATL namespace or, if not, does nothing.
#define	atlstl_destroy_instance(t, _type, p)   STLSOFT_DESTROY_INSTANCE(t, _type, p)
	[DEPRECATED] Destroys the given instance p of the given type (t and _type)
#define	atlstl_gen_opaque(_htype)   STLSOFT_GEN_OPAQUE(_htype)
	[DEPRECATED] Generates an opaque type with the name _htype
Functions
bool	InlineIsEqualGUID (REFGUID rguid1, REFGUID rguid2)
	This function is needed since there are ambiguities between COM headers and ATL headers.

---

Define Documentation

#define _ATLSTL_VER   _ATLSTL_VER_1_6_2

The current composite version number of ATLSTL.

#define _ATLSTL_VER_MAJOR   1

The major version number of ATLSTL.

#define _ATLSTL_VER_MINOR   6

The minor version number of ATLSTL.

#define _ATLSTL_VER_REVISION   2

The revision version number of ATLSTL.

#define ATLSTL_ASSERT

(

expr

)

STLSOFT_ASSERT(expr)

Defines a runtime assertion.

Parameters:

expr

Must be non-zero, or an assertion will be fired

Referenced by EnhancedWindow< atlstl::Window >::EnableDlgItem(), EnhancedWindow< atlstl::Window >::GetDlgItemTextLength(), EnhancedWindow< atlstl::Window >::IsDlgItemEnabled(), EnhancedWindow< atlstl::Window >::SetDlgItemFocus(), and EnhancedWindow< atlstl::Window >::ShowDlgItem().

#define atlstl_destroy_instance	(	t,
		_type,
		p		)	STLSOFT_DESTROY_INSTANCE(t, _type, p)

[DEPRECATED] Destroys the given instance p of the given type (t and _type)

Deprecated:

This is heavily deprecated in favour of STLSOFT_DESTROY_INSTANCE().

#define atlstl_gen_opaque

(

_htype

)

STLSOFT_GEN_OPAQUE(_htype)

[DEPRECATED] Generates an opaque type with the name _htype

Deprecated:

This is heavily deprecated in favour of STLSOFT_GEN_OPAQUE().

#define ATLSTL_MESSAGE_ASSERT	(	msg,
		expr		)	STLSOFT_MESSAGE_ASSERT(msg, expr)

Defines a runtime assertion, with message.

Parameters:

	expr	Must be non-zero, or an assertion will be fired
	msg	The literal character string message to be included in the assertion

Referenced by IDispatchImpl4::GetIDsOfNames(), IDispatchImpl3::GetIDsOfNames(), and IDispatchImpl2::GetIDsOfNames().

#define atlstl_ns_qual

(

x

)

::atlstl::x

Qualifies with atlstl:: if ATLSTL is using namespaces or, if not, does not qualify.

#define atlstl_ns_qual_atl

(

x

)

::ATL::x

Qualifies with ATL:: if ATLSTL is being translated in the context of ATL being within the ATL namespace or, if not, does not qualify.

#define atlstl_ns_qual_std

(

x

)

::std::x

Qualifies with std:: if ATLSTL is being translated in the context of the standard library being within the std namespace or, if not, does not qualify.

#define atlstl_ns_using

(

x

)

using ::atlstl::x;

Declares a using directive (with respect to atlstl) if ATLSTL is using namespaces or, if not, does nothing.

#define atlstl_ns_using_atl

(

x

)

using ::ATL::x;

Declares a using directive (with respect to ATL) if ATLSTL is being translated in the context of ATL being within the ATL namespace or, if not, does nothing.

#define atlstl_ns_using_std

(

x

)

using ::std::x;

Declares a using directive (with respect to std) if ATLSTL is being translated in the context of the standard library being within the std namespace or, if not, does nothing.

#define ATLSTL_STATIC_ASSERT

(

expr

)

STLSOFT_STATIC_ASSERT(expr)

Defines a compile-time assertion.

Parameters:

expr

Must be non-zero, or compilation will fail