framework::LoadEnvException Class Reference

specify an exception, which can be used inside the load environment only. More...

#include <loadenvexception.hxx>

Public Types
enum	EIDs {   ID_UNSUPPORTED_CONTENT ,   ID_INVALID_MEDIADESCRIPTOR ,   ID_INVALID_ENVIRONMENT ,   ID_NO_TARGET_FOUND ,   ID_COULD_NOT_REACTIVATE_CONTROLLER ,   ID_STILL_RUNNING ,   ID_GENERAL_ERROR }
	Can be used as an ID for an instance of a LoadEnvException. More...

Public Member Functions
	LoadEnvException (sal_Int32 id, OUString message=OUString(), css::uno::Any original=css::uno::Any())

Public Attributes
sal_Int32	m_nID
OUString	m_sMessage
css::uno::Any	m_exOriginal

Detailed Description

specify an exception, which can be used inside the load environment only.

@descr Of course outside code must wrap it, to transport the occurred information to its caller.

Definition at line 33 of file loadenvexception.hxx.

Member Enumeration Documentation

EIDs

enum framework::LoadEnvException::EIDs

Can be used as an ID for an instance of a LoadEnvException.

@descr To prevent errors on adding/removing/changing such IDs here, an enum field is used. Its int values are self organized...

Enumerator
ID_UNSUPPORTED_CONTENT	The specified URL/Stream/etcpp. can not be handled by a LoadEnv instance.
ID_INVALID_MEDIADESCRIPTOR	indicates a corrupted media descriptor. @descr Some parts are required - some other ones are optional. Such exception should be thrown, if a required item does not exists.
ID_INVALID_ENVIRONMENT	Its similar to a uno::RuntimeException... @descr But such runtime exception can break the whole office code. So its capsulated to this specialized load environment only. Mostly it indicates a missing but needed resource ... e.g the global desktop reference!
ID_NO_TARGET_FOUND	indicates a failed search for the right target frame.
ID_COULD_NOT_REACTIVATE_CONTROLLER	TODO.
ID_STILL_RUNNING	indicates an already running load operation. Of course the same instance can't be used for multiple load requests at the same time.
ID_GENERAL_ERROR	sometimes we can't specify the reason for an error, because we was interrupted by a called code in an unexpected way ...

Definition at line 40 of file loadenvexception.hxx.

Constructor & Destructor Documentation

LoadEnvException()

framework::LoadEnvException::LoadEnvException ( sal_Int32  id, OUString  message = OUString(), css::uno::Any  original = css::uno::Any()  )

inline

Definition at line 78 of file loadenvexception.hxx.

Member Data Documentation

m_exOriginal

css::uno::Any framework::LoadEnvException::m_exOriginal

Definition at line 76 of file loadenvexception.hxx.

Referenced by framework::LoadDispatcher::impl_dispatch().

m_nID

sal_Int32 framework::LoadEnvException::m_nID

Definition at line 74 of file loadenvexception.hxx.

Referenced by framework::LoadDispatcher::impl_dispatch().

m_sMessage

OUString framework::LoadEnvException::m_sMessage

Definition at line 75 of file loadenvexception.hxx.

Referenced by framework::LoadDispatcher::impl_dispatch().

---

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

• loadenvexception.hxx