SUException Class Reference

A wrapper class for error return values. More...

#include <ShapeUpAPI.h>

List of all members.

Public Member Functions
	SUException (SURESULT res)
SURESULT	GetErrorCode () const
std::string	GetErrorDesc () const
Protected Attributes
SURESULT	_res

---

Detailed Description

An SUException is thrown from the SU classes when an error code is returned from ShapeUp.

Examples:

example_sudatapage.cpp, and example_sutoolbar.cpp.

---

Constructor & Destructor Documentation

SUException::SUException

(

SURESULT

res

)

[inline]

Constructor.

Parameters:

res

is a SURESULT value from a ShapeUp call.

---

Member Function Documentation

SURESULT SUException::GetErrorCode

(

)

const [inline]

Getter for the error code.

Returns:

The actual SURESULT.

std::string SUException::GetErrorDesc

(

)

const [inline]

Translates the underlying SURESULT into a human readable string.

Returns:

The error description.

Examples:

example_sudatapage.cpp, and example_sutoolbar.cpp.

---

Member Data Documentation

SURESULT SUException::_res [protected]

---

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

• ShapeUpAPI.h

---