guid Class Reference
[COM Utility Library]

#include <comstl/util/guid.hpp>

List of all members.

---

Detailed Description

Facade for the COM GUID type.

Examples:

by_project/comstl/comstl.cpp.

Public Types
Types
typedef guid	class_type
typedef GUID const &	resource_type
Public Member Functions
Construction
	guid ()
	Constructs with a new, unique, GUID value.
	guid (char const *s)
	Constructs with a GUID value equivalent to the given ANSI string.
	guid (wchar_t const *s)
	Constructs with a GUID value equivalent to the given Unicode string.
	guid (GUID const &g)
	Copy constructs from the given GUID.
	guid (class_type const &rhs)
	Copy constructor.
guid &	operator= (class_type const &rhs)
	Copies the given instance.
guid &	operator= (char const *s)
	Assigns to a GUID value equivalent to the given string.
guid &	operator= (wchar_t const *s)
	Assigns to a GUID value equivalent to the given string.
guid &	operator= (GUID const &g)
	Copies the given GUID value.
Accessors
GUID const &	get () const
Comparison
bool	equal (class_type const &rhs) const
	Evaluates whether the value is equivalent to the given argument.
bool	equal (GUID const &rhs) const
	Evaluates whether the value is equivalent to the given argument.
Operations
void	swap (class_type &rhs) throw ()
	Swaps the contents with the given instance.

---

Constructor & Destructor Documentation

guid

(

)

Constructs with a new, unique, GUID value.

Note:

If a new value cannot be aquired, then an instance of com_exception is thrown if compiled under conditions where exceptions are supported (STLSOFT_CF_EXCEPTION_SUPPORT is defined), or the instance GUID is set to GUID_NULL otherwise.

guid

(

char const *

s

)

[explicit]

Constructs with a GUID value equivalent to the given ANSI string.

Parameters:

s

The string form of the desired GUID

Example:

  guid  g("{00000303-0000-0000-C000-000000000046}");

Note:

If a new value cannot be determined, then an instance of com_exception is thrown if compiled under conditions where exceptions are supported (STLSOFT_CF_EXCEPTION_SUPPORT is defined), or the instance GUID is set to GUID_NULL otherwise.

guid

(

wchar_t const *

s

)

[explicit]

Constructs with a GUID value equivalent to the given Unicode string.

Parameters:

s

The string form of the desired GUID

Example:

  guid  g(L"{00000303-0000-0000-C000-000000000046}");

Note:

If a new value cannot be determined, then an instance of com_exception is thrown if compiled under conditions where exceptions are supported (STLSOFT_CF_EXCEPTION_SUPPORT is defined), or the instance GUID is set to GUID_NULL otherwise.

guid

(

GUID const &

g

)

[explicit]

Copy constructs from the given GUID.

guid

(

class_type const &

rhs

)

Copy constructor.

---

Member Function Documentation

guid& operator=

(

class_type const &

rhs

)

Copies the given instance.

guid& operator=

(

char const *

s

)

Assigns to a GUID value equivalent to the given string.

Parameters:

s

The string form of the desired GUID

Example:

  guid  g;

  g = "{00000303-0000-0000-C000-000000000046}";

Note:

If a new value cannot be determined, then an instance of com_exception is thrown if compiled under conditions where exceptions are supported (STLSOFT_CF_EXCEPTION_SUPPORT is defined), or the instance GUID is set to GUID_NULL otherwise.

guid& operator=

(

wchar_t const *

s

)

Assigns to a GUID value equivalent to the given string.

Parameters:

s

The string form of the desired GUID

Example:

  guid  g;

  g = L"{00000303-0000-0000-C000-000000000046}";

Note:

If a new value cannot be determined, then an instance of com_exception is thrown if compiled under conditions where exceptions are supported (STLSOFT_CF_EXCEPTION_SUPPORT is defined), or the instance GUID is set to GUID_NULL otherwise.

guid& operator=

(

GUID const &

g

)

Copies the given GUID value.

bool equal

(

class_type const &

rhs

)

const

Evaluates whether the value is equivalent to the given argument.

bool equal

(

GUID const &

rhs

)

const

Evaluates whether the value is equivalent to the given argument.

void swap

(

class_type &

rhs

)

throw ()

Swaps the contents with the given instance.

---

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

• comstl/util/guid.hpp